{ "item": [ { "id": "e59f934f-0bb1-45c7-9ec7-dcd0a94fa1e7", "name": "Affiliate", "description": { "content": "Affiliate endpoints.", "type": "text/plain" }, "item": [ { "id": "e0c8d73b-a790-4fe0-84ee-8c56830f85aa", "name": "List Affiliates", "request": { "name": "List Affiliates", "description": { "content": "Retrieves a list of Affiliates", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `id` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `name` - Wildcard matching allowed\n- (String) `contact_id`\n- (String) `referral_contact_id`\n- (String) `status`\n- (String) `code`\n- (Custom) Custom field names - Reference by field name (e.g., `tier`, `region`)\n\nYou will need to apply the `==` operator to check the equality of one of the filters with the\nvalue you want to match, in the encoded form `%3D%3D`. For the filters listed above,\nhere are some examples:\n- `filter=id%3C123`\n- `filter=id%3D%3D123`\n- `filter=name%3D%3DBob`\n- `filter=contact_id%3D%3D567`\n- `filter=contact_id%3D%3D123%3Bcode%3D%3D567`\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n\nCustom Field Filtering:\nCustom fields are referenced by their field name as configured in the system.\nStandard field names take precedence over custom field names.\n\nSupported operators by field type:\n- Text fields and single-value choice fields with text options (dropdown, radio, state): ==, and wildcard support (e.g., `value*`)\n- Numeric fields (including user, month, day of week): ==, <, <=, >, >=\n- Date fields: ==, <, <=, >, >= (ISO 8601 format)\n- Yes/No and drilldown fields: ==\n- Multi-select fields: == (matches if value is present)\n\nExamples of custom field filtering:\n- `filter=tier%3D%3DPlatinum` - Text field exact match\n- `filter=region%3D%3DWest%2A` - Text field with wildcard (starts with \"West\")\n- `filter=revenue%3E100000` - Numeric field greater than 100000\n- `filter=join_date%3E%3D2024-01-01` - Date field on or after Jan 1, 2024\n- `filter=name%3D%3DBob%3Btier%3D%3DGold` - Combine standard and custom fields\n\nNote: Leading wildcards (e.g., `*value`) are not supported for performance reasons.\nOnly prefix wildcards (e.g., `value*`) are allowed.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `date_created`\n- `name`\n- `status`\n- `code`\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ef1bfd56-7eaa-4480-9785-9aa318349205", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d852c014-2c6b-4be7-a2e2-13b04ad7e864", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a16d059-2e9f-4f20-9b3f-0c92e649d896", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ce23e26-e5dc-46b2-bdd5-7f69eae364dc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59833c82-82fa-4393-ab82-add868260b71", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045d14f7-3124-4f81-a609-9b819476b259", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe0e4ecc-0921-48cc-bdcd-c0f45a2a65d7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96150353-3b48-44cf-a667-56c98608b6ae", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ddf0e2-739a-4bb3-bd00-2fdd049344eb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ce032f1-5baa-4722-8ee6-560fd10f1eb8", "name": "Create an Affiliate", "request": { "name": "Create an Affiliate", "description": { "content": "Creates a single Affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9536ef10-9228-4c36-9e3f-53923aec45e2", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"unique_site_id\": \"string\",\n \"date_created\": \"2024-03-15T10:30:00Z\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda2b8d5-909e-47e5-a470-ff9b7c655589", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "746f02b8-f97b-45b0-99a3-97f15f65a441", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44832fc1-3854-4ab3-a050-f65d3e220bad", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a01f952-956f-49c1-83b4-9a004f2edefc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b157799e-39f4-41e6-97aa-8874755b956d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1122182c-e7b8-410c-8a65-f673a5962ef3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afcfe013-0976-4863-bc52-e691e39b4764", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afca9b47-5fa0-45c4-8b92-835b28a926ad", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"contact_id\": \"string\",\n \"status\": \"ACTIVE\",\n \"name\": \"John Smith\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc022cb3-6441-4849-94e7-4872955f6f6f", "name": "Remove an Affiliate from a Commission Program", "request": { "name": "Remove an Affiliate from a Commission Program", "description": { "content": "Removes an Affiliate from a Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f3d18150-c9a8-42b6-9e91-9feeaa7235d1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "66846dff-bd8c-45af-a801-e56cc57a4454", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8b60bb-b626-4a39-830f-31b3abc9a778", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c6ee28-108d-4c91-98c8-4ed01f7f8cf5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79f9533-1013-4b2d-a2cf-407d265a9c03", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5325cf07-4316-4eba-817e-6fae1e3ea597", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44e5562-6e1d-4c48-8bf6-76bb1b7a04ba", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26d25b9a-749b-4afc-91f7-3e69ceb4e09a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52fb3bbd-9a54-4270-8712-2f0826a3314b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:removeFromProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22d5e908-2865-4dd0-829b-d980460f6621", "name": "Assign Affiliate to Commission program", "request": { "name": "Assign Affiliate to Commission program", "description": { "content": "Assigns an Affiliate to Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "997869b2-6b8c-4add-bd6b-e1854c59606f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "720831d2-61f0-4806-9778-7063b792be40", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0883f0bc-7c5b-42d8-a826-4659d08a5d12", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11b23f73-9fbd-46fa-96a6-509a723d63e6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f60155-f437-4b6a-b23b-00965d2ae35c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d741a3f2-a2c6-4e6d-9c5c-435a5d3b25d4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c772163b-75be-479c-8caf-a628e7f74f04", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1189eb2b-c9c8-4b72-96f1-35c9ffffc0dc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59fceb62-491a-4f69-a4be-81f305d1bc9d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{id}}:assignToProgram" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_program_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d18e6ef-acf2-470e-b909-2775b7ecf760", "name": "List Affiliate Links", "request": { "name": "List Affiliate Links", "description": { "content": "Retrieves a list of Affiliate Links", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `affiliate_id`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `date_created`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "272737c8-ea28-4c18-9555-03d262c784ac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate_links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "498994ec-058b-445b-870b-398964d14892", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "282eebe4-6117-40b4-a4d1-66021a756040", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca93c158-c433-43aa-a613-6a8ec85d5385", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65268855-5197-48b0-a648-4be4760f6e94", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc54bd1a-c388-4a59-9361-7ea212d339de", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c773b9c-1b20-4234-b0fa-8a4a21b62fb9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6716020-7e1c-4238-9d30-472188a01f01", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd5d6ca6-054b-48a6-9a46-3763eefd809e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bd31ec2-7a29-4c76-b5ec-94762f55e77c", "name": "Create an Affiliate Link", "request": { "name": "Create an Affiliate Link", "description": { "content": "Creates a single Affiliate Link", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba2184e0-3116-4b36-9364-f37adb8b7b8a", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Fitness Program\",\n \"code\": \"fP100\",\n \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"https://thryv.com/fitness\",\n \"website_address\": \"https://thryv.com/fitness\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ],\n \"date_created\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28fb5ac8-0fa5-453f-b1c2-9ce75f08982f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e945a5ba-f5df-4c76-888f-bed88549e437", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d56a667-cb9e-49ec-844b-249307e32941", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbee3ea3-5167-408b-ad54-018491462f29", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5e64b64-5a3d-48d4-adcc-8d8354d23b0a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bff4b5f-6f3a-414f-aba0-b303f0e8bf89", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2665e4f9-d1b4-45e3-b8f7-7f6b655f993b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f310f4-25c8-4eda-a0d7-85d7863cc564", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40df0051-48b5-4a41-a9db-bb6b82a61987", "name": "Create an Affiliate Custom Field", "request": { "name": "Create an Affiliate Custom Field", "description": { "content": "Creates a single Affiliate Custom Field", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9ca8796d-c942-4126-82cf-22de6f374e69", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62ea75a8-305b-4c0d-9fc5-974b69be0173", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d10cc6-4ee1-4fae-8677-3359f14add06", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ed427f-63a7-499d-81ae-724df3655794", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d9fc1f8-affe-4ad7-83a9-dc0bfe1991ac", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc3cca90-247f-4e85-85a6-ac0d8547a8ae", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb61b01-155b-4e5c-b10f-008830a5c064", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "939648d9-91c2-4809-87c5-c2932b197fe3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af918671-637b-4e4b-8f86-e2e2995ab23e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2d427e3-22cc-4e4d-914e-eb944b43bcd0", "name": "List Affiliate Custom Field Tabs", "request": { "name": "List Affiliate Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Affiliate record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1badccb2-07b9-42b2-858b-62deca3de415", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5cb1b6d-7a6d-412a-b107-56a0fdb158fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768af36b-73ec-4a81-b7eb-073c766c9173", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb6a013-1add-4229-9d74-e44439730d44", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a1b5cbe-a494-4a41-8e13-bf80f5054e20", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49855a5-a66e-4ff0-979d-e9e1006e4a03", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f8ba66e-38d6-43bd-b953-6510fed3fbf0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d242942-1941-4f2c-bff8-951678d55a26", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "794f2e26-9920-47ca-8fac-4559d3068fdc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afc9754d-8df5-4448-9146-9ff316837323", "name": "Create an Affiliate Custom Field Tab", "request": { "name": "Create an Affiliate Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Affiliate record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9fa4e410-0592-47c2-a777-1c94845b68e1", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61297b63-1b2b-471a-a615-cac708bdfea1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5995cf9-5bb5-4d19-8766-fdd78ddbcce5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3be22b6-657c-4f2e-abe2-c19544bce560", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd030b15-9907-4e19-b599-34b6d65019e7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ea15ffd-fc83-4f90-a8da-4061d44c98ab", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87c62198-dc3c-4cc4-b6e6-faf6f10b3c3b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23162ece-8152-4dec-ba41-c005b61425f8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01959e74-b455-4b7f-a23b-cc1d1da0ea98", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fcf38385-a8d5-488f-bf1c-32b5aa954a05", "name": "List Affiliate Custom Field Groups", "request": { "name": "List Affiliate Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Affiliate record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e0dc23a1-307d-4287-a27d-b906a52f05b9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1782cba8-b0cc-48f0-93cd-66202fd4dcf1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc93d5ee-f314-4a18-ab8a-3993aa16e038", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b24f35da-2d8e-4e50-8984-310b754cc38a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b49bd41-bb7e-4407-badf-4f7e17cdb481", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f9f417-dd3a-4106-9ab6-0c9feda39b06", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3a22c01-c5dd-43ca-8501-6697926edf4b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671ab110-2737-431b-9bb9-dc2cfcc3d7fc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b287277-8a2b-431a-b640-3f2f8285b8a9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79061728-bee0-44d6-b955-717546e2a957", "name": "Create an Affiliate Custom Field Group", "request": { "name": "Create an Affiliate Custom Field Group", "description": { "content": "Creates a new custom field group for the Affiliate record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e40d967d-36c5-44f2-8032-627e34688b7e", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6de6c5-4b49-4ff1-8589-9fa804291611", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da704ca1-7e4d-4311-8219-69e81f1e6eaa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa86c74e-092f-49d1-8e1b-bc659d7009dd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42497666-bc2b-4a3c-9805-cde9c28e6fe7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af42d765-47c6-46e2-a550-741c5424404b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "319e964c-3ac0-44ca-b234-357cf88a6929", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c77c104-f0fc-4cae-a945-220508e04a65", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a5fd8c-2b03-42a3-9ac2-a1ef5c6bea02", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "472fc96e-e75f-42af-aec3-5a615b717e16", "name": "List Affiliate Commission Programs", "request": { "name": "List Affiliate Commission Programs", "description": { "content": "Retrieves a list of Affiliate Commission Programs", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `affiliate_id`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `date_created`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "93040f70-8a5a-48c1-916e-a31b0889631a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commission_programs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9deb750b-588b-4d97-b6c7-9d710bb1de3e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00becca6-9249-4b52-ab61-f730f9b89439", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104debd0-8941-4d5a-9dab-e5fb65d12b73", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0089939b-7bd7-4d11-a528-c03627688305", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "017b93d6-83c3-43fe-a7a9-d67750ab5468", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdbf846b-f190-43cd-9e53-7478192030cf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd25280-731a-4836-9f88-5b833da74d56", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d775cb0-3a16-4af1-a34c-5a8a9b6d71d6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0265052-c206-4037-a90f-6ac16af709ba", "name": "Create an Affiliate Commission Program", "request": { "name": "Create an Affiliate Commission Program", "description": { "content": "Creates an Affiliate Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81c1c27e-ba18-4a16-9a27-87418ba1e1ff", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Gold Partner Program\",\n \"notes\": \"20% commission on all sales\",\n \"priority\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a25999ff-a444-4ed7-a060-04d63a7fe6fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1caf2924-98e4-400b-9dfa-66b6239ac0ce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55b96c3e-c33d-446a-b346-2f800dd1ba4f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e57d6305-233a-4ef7-ba83-14f74b79fa76", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9755d544-4446-4bd3-9a57-01cd211f9c6b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4894caa-8c0a-4c84-825c-0e94dc3b2137", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea3351c4-ed97-4aa9-b5d6-040f80c29963", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6fd0a32-4774-4d8a-8228-62b9c87306f4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"priority\": 1,\n \"notes\": \"20% default commission\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "339e2f46-f7e6-4e97-ab9c-a422516f4244", "name": "Remove a Subscription from a Commission Program", "request": { "name": "Remove a Subscription from a Commission Program", "description": { "content": "Removes a Subscription from a Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6cc2416-e2a7-4232-90ae-a2b5c32ccd8a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b49ffbd1-a937-4ac9-b75c-ca58dc35a25b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b0f7ca8-c216-4732-b466-3e515a105328", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "156ef050-3365-4ebc-a071-73b20aea03a0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "067b800e-e8dd-4cb4-aa68-a67c2ea07ef5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "400348ec-81bc-46ff-8046-49fa5f72ead3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e33d010-10f5-46e3-be0e-5524b115f676", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50e1436e-7f84-463a-8153-1092dd4bc675", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a3e77e2-c75b-472c-a3e0-b54e46bfcb4b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeSubscriptionCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70103a1f-ff0b-440f-a20e-e3a2da5f99af", "name": "Remove a Product from a Commission Program", "request": { "name": "Remove a Product from a Commission Program", "description": { "content": "Removes a Product from a Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d661b6d7-c692-43d5-9d03-fd3d030f49c0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f5eb747-8079-4e0a-a213-56e89e122538", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f186d658-bdb9-435b-be43-f5e799d489d2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c2aed6d-d26f-4eea-8b1c-aa80ec4e3c91", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a075f3-cade-44d3-8cdb-d51534ad3d52", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea94af6-376b-4b2f-9fbb-6511e28e1b00", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d535e56b-9595-4fb1-925c-e3ae24041fc2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f5e60f-b6e2-4956-9461-95918ad86f00", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dd66746-570b-4692-b528-fb4458fb0c73", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "{{commission_id}}:removeProductCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "211b53dd-3d40-4d3d-8d5c-ba9fc743c73d", "name": "Assign a Subscription Commission Program", "request": { "name": "Assign a Subscription Commission Program", "description": { "content": "Assigns a Subscription Commission Program to a Subscription", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e19eb7a-ac3b-4265-ab42-0eb536999f8b", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "368069c0-1e7a-4cda-a7e9-a8e2e4a4b37a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d12f50-1330-4c3c-819f-4264c5b1892d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b04fd55a-2e39-4f38-8dda-a93e2005d5a1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4498208e-b3e2-48a4-9c60-a2034fcef159", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e20ee7-917a-45c0-9d47-cc91f6b6c9ae", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3997baa-a4f9-47e7-aa2e-73649709981e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82e51a07-f120-4e4d-aaf0-11cde3dd07da", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6c033dc-4a30-4522-b28c-286af738d5b8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d62acc9b-dc03-4276-b1b2-7efd92d06010", "name": "Update a Subscription Commission Program", "request": { "name": "Update a Subscription Commission Program", "description": { "content": "Updates a Subscription Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "unused", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "level_2", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bcb11566-d945-4357-a53f-6fc2ad0e2903", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7787a26-6538-4d80-a013-89567800ad24", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d9a0669-b236-4db1-a038-f96c3588d87e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8feafe1-1440-40b4-a03e-da3f059dff87", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d171da2c-f09f-4b50-8ccc-43bf05977f41", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9d44fd-e124-4cfa-8106-7eed8f98878d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd4d5f4f-ebfa-4b87-a1da-98f87cb4a0ca", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fca403c-20e4-4363-bdcd-c0d9128361d2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72286d9-11a4-4ae7-ba57-641e17f8322e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"subscription_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eaffacb0-84a0-4b21-8958-ab315b152e63", "name": "Create Commission Program Resource", "request": { "name": "Create Commission Program Resource", "description": { "content": "Creates a resource for a commission program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b94d03a-0c7d-41ea-9d8d-a7d7e31f73a8", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_programs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9d2f0cb-e4f8-46ed-9d48-b00e39442afe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a792dd44-d2e1-4ac6-9960-dbe173fb30a8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "846a3997-ac6b-41c2-b392-3e021fa2354d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e92f711-73c8-48ac-9cec-75b61956b675", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a376d69c-6dac-410d-bfc8-96f8e8478043", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc1fabb-5ba9-498f-b057-fcd5992a6bf3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "114f7a3a-8f71-4ac9-b17c-b7d1ea29960c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197f4b94-0d77-4a5d-9a2f-8040b55df918", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ],\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a85cdf45-aec7-42a0-bd91-0effe0e2e8d5", "name": "Assign a Product Commission Program", "request": { "name": "Assign a Product Commission Program", "description": { "content": "Assigns a Product Commission Program to a Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "349cec75-4acc-476c-bf73-87244feef4a8", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e3bf33-0f97-407d-a973-a4d18d24f4e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a09108f-db80-40da-a6f1-0f82af30f161", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ad6111f-b4f2-4d5f-bc4b-fadb4ae90a84", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaede8a4-ec8f-4272-8bd7-bc71689895e5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "119709fc-bc4f-415c-a3d4-fe5ab80aa069", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fddf35bd-b376-4087-8687-40bfeb9f85d8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4015f62-9cd1-4b61-8e7e-34cddfa0ed9e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19dd1ae9-312f-4bbe-93c2-904e63bdf015", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\",\n \"product_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93e5275c-f08e-45e4-9c32-4aed3ec77c88", "name": "Update a Product Commission Program", "request": { "name": "Update a Product Commission Program", "description": { "content": "Updates a Product Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "unused", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "level_2", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "af746a06-5730-4922-becb-a6a1c492aa61", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48006d77-ae07-4833-8468-074d9ba76836", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3416b520-dff6-471f-8160-797c6ef09609", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "647fdb77-3b39-405f-950a-147ede12502e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22aa0c43-b331-4e61-9114-20f0180843c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce8b877c-b2e0-4e26-ac0b-f9ed872da273", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a18a087-026f-4010-a04e-b112f9c5f605", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8176838-80e0-43c5-873f-3e45bf95c9e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23373aca-4c3f-4349-aa82-932c3316e722", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"product_id\": \"string\",\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37b5dc8d-0115-4fc0-ad25-9a533b842dac", "name": "Create a Default Commission Program", "request": { "name": "Create a Default Commission Program", "description": { "content": "Creates a Default Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a7b2a50b-2ba9-45ec-b98f-c69d0f7c2f8e", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10d34778-56ef-42be-81ef-a4c167fba4d6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "458d24a4-7280-49c6-a197-3881fa5a3eb2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b7a48b5-0965-4a22-a3f7-aa7beb999b6e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba3ec4cc-51f7-4628-b723-5897bed84943", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac14186-0ce1-427a-ad2f-a101a1d2879f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38bc00cc-a449-407b-b306-47e3e8d14181", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ea419c-c9ba-4e88-bdb1-f6cf23b1e0fa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5620d8e-6f8e-4db1-9e83-46b1e67891be", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c1dd6bb-8c8c-4455-abd0-6bc17aedf181", "name": "Update a Default Commission Program", "request": { "name": "Update a Default Commission Program", "description": { "content": "Updates a Default Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "unused", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "level_2", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bb90a43d-6853-4b25-82d6-e08b9b918205", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b433e0d-729e-46a2-8151-d5a1cc8dc9ee", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c75abb-6c32-4ffa-a26a-465a1c07d302", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b3c0676-48c4-499a-9a81-8320c61a01cc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef34356-61fb-424e-8a9d-7b0d2e5465ea", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ca9432-ac5f-4a2f-8cb7-c4d1fd8ec32e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e44ad0d-2d72-4d69-90e8-5c550e042eec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26833bb2-7357-454f-81a9-eefa3f8a206b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17e45e30-f4e7-4c10-b897-113f4fcb746a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "payout_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"percentage\": \"string\",\n \"unused\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"dollar_amount\": \"string\",\n \"level_1\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"level_2\": {\n \"sale_percent\": {\n \"value\": \"\"\n },\n \"sale_amount\": {\n \"value\": \"\"\n },\n \"lead_percent\": {\n \"value\": \"\"\n },\n \"lead_amount\": {\n \"value\": \"\"\n }\n },\n \"payout_type\": \"UPFRONT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebddf814-8ef2-425b-9a64-45ede818472b", "name": "Retrieve an Affiliate", "request": { "name": "Retrieve an Affiliate", "description": { "content": "Retrieves a single Affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "517d8348-cd74-4873-a9e4-cce7e7c97e17", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"unique_site_id\": \"string\",\n \"date_created\": \"2024-03-15T10:30:00Z\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2ce4c0c-3064-4c4d-8cae-3440cb4be517", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8149bf95-9f19-4fd7-ae4c-2e10b25a2e94", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2459b1c-bd8a-4d4e-b323-275ece90d563", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8767384-9345-4e18-b479-2ec7c044f7a3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7598d80a-d088-44c2-ace2-98363e2dad46", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c3ce88-c67c-4ad8-976d-5dc6819573cc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a20de26-28f9-49e4-a8d3-c336d3fe08ee", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5db5068-348c-4213-9c42-5fd655384514", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d17cbb13-4c8e-4484-b111-f5fde751b3e2", "name": "Delete Affiliate", "request": { "name": "Delete Affiliate", "description": { "content": "Deletes the specified Affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "36f0978e-81a0-4bc3-8d6d-7d22465beba6", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73f2dca0-73d3-4343-abae-c3a4348df610", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "411830df-361d-4faf-8025-bf3d04b6b6b9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8406933-9f34-4096-a727-7bcc9f924568", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63d480c-5eea-4f3d-86cb-30225f2dd9f6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f1f30f5-950d-4884-8e13-38c5a5648af8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d03160c-e1ab-408f-9e5e-3fe87c9d6f0e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "388b2b3c-2454-4380-a363-266e14ed6056", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dbbd1fb-f90b-4dba-90da-dc8bf1723734", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "325ac665-dcd7-4335-9736-f58919171f3a", "name": "Update an Affiliate", "request": { "name": "Update an Affiliate", "description": { "content": "Updates a single Affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "password", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "status", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5bb4f011-b30e-4e5d-9068-5048f0473afb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"unique_site_id\": \"string\",\n \"date_created\": \"2024-03-15T10:30:00Z\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9bcbf83-cc5d-4ad1-9e0f-5815e871847d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6879b2eb-dddb-4496-9e1a-98a3d4a5ac4f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae3e8fea-50aa-41b9-9aee-61c428d6b410", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a2e9031-7f25-478c-8e19-11d8de945b21", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a8a509-e0e8-428a-8909-6201d8414496", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b995302b-5ab6-49cb-b886-51f6558b1892", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4deb2c-4b21-4859-acc7-addab9f30e75", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7475c65a-fbd4-4371-9eb7-8d8f33528e68", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"M123\",\n \"name\": \"John Smith\",\n \"status\": \"ACTIVE\",\n \"contact_id\": \"string\",\n \"parent_affiliate_id\": \"string\",\n \"notify_on_sale\": true,\n \"notify_on_lead\": true,\n \"track_leads_days\": 30,\n \"password\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5695ef6-3b17-4f1a-ad78-d8ea315a486e", "name": "Retrieve an Affiliate Link", "request": { "name": "Retrieve an Affiliate Link", "description": { "content": "Retrieves information about a single Affiliate Link", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d51b552a-a812-49bf-b8d3-1f0b542106e8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Fitness Program\",\n \"code\": \"fP100\",\n \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"https://thryv.com/fitness\",\n \"website_address\": \"https://thryv.com/fitness\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ],\n \"date_created\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbc30d48-88d3-45d6-b678-caecb0c95004", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea0dfac1-b413-4252-9564-e10c8630a7e6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68f1870d-6360-4589-8cf0-bddd4407a297", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e63b2b-b86b-480d-97b9-542c482410c4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9785ac47-68f5-48eb-9457-10eef8e9f233", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6845a7c-82a9-4db4-91b4-10dafa1d9067", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "551b8415-b623-48bf-a126-7097cd7ef2c3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96af129-9ce6-4c63-8bb6-edab19e1c71b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "959d1bd0-5c50-4e3b-ac6c-b32c154ca361", "name": "Delete an Affiliate Link", "request": { "name": "Delete an Affiliate Link", "description": { "content": "Deletes an Affiliate Link", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f9b34317-5ce7-455d-b4c8-2ae31837e2d6", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9146f4b7-adc3-406e-a0a2-2c1696d03677", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b534e5e8-ec5a-4975-b027-bb35656eee08", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c12c20be-6082-4236-a4a1-eb915096ef14", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1147253b-c4da-445e-990d-ee52872fb73e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beee7245-3225-4e94-b804-38c01acb508e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf873d5-dc67-43a4-ab4f-2fd770531467", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f411f48b-ff2d-4572-972f-5497663d95db", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ac52aa-46e1-43b2-b4bd-3716b8da734d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6d0eceb-256a-4fd1-881b-31495026c137", "name": "Update an Affiliate Link", "request": { "name": "Update an Affiliate Link", "description": { "content": "Updates an Affiliate Link", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59ebc5c7-1b0e-43b3-8c88-e9562b3c5d63", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Fitness Program\",\n \"code\": \"fP100\",\n \"affiliate_id\": \"string\",\n \"local_url_code\": \"fP100\",\n \"redirect_url\": \"https://thryv.com/fitness\",\n \"website_address\": \"https://thryv.com/fitness\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ],\n \"date_created\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70f415bf-3d60-4bb2-b8fa-3fae87e3f100", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21387ec2-516a-420e-b18e-c5c99ba649e6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40186710-cbd3-41f0-8aba-1a4a0209cbe0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8d5f504-e912-4a94-a297-42a04b3d369c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db4a435-1851-451a-b38e-3bdaefdd01fb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e98a7262-b8f5-4bf1-92f7-ef7c40cf61bb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b307ec46-6bac-48c6-aea0-932b975d76f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00126939-ea21-41cb-8280-672a3eaf206a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "redirects", ":redirect_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "redirect_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"code\": \"fP100\",\n \"name\": \"Fitness Program\",\n \"website_address\": \"https://thryv.com/promo\",\n \"affiliate_id\": \"string\",\n \"program_ids\": [\n \"1\",\n \"2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b7628d8-1de2-44cb-8cc0-7482bfe28565", "name": "Delete Affiliate Custom Field", "request": { "name": "Delete Affiliate Custom Field", "description": { "content": "Deletes a Custom Field from Affiliate.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4b734a26-c58d-48ee-89c8-833485aa7db1", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1d9825d-0e18-401d-81f6-122723d9d8dd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37cee740-c00d-4210-b192-ed84a8c7c0a8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "977e32f1-cb2f-44f0-9fc6-88b28476cbbd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be10b18-6975-4f16-a712-07a4dc301d82", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a0f01b-9931-4d8b-8115-d316b9119b98", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf7ea59-2044-4155-a40b-cb2355befac1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d520c39d-6d0b-4d47-8d1e-6eb4b9416583", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbf066af-7e63-45f8-b7de-f5bf06ef5053", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "622cd8e2-7686-40cd-aa8d-be046f5a38cd", "name": "Update Affiliate Custom Field", "request": { "name": "Update Affiliate Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Affiliate object.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75ea96f8-1a1e-4147-99fb-f7247ef020bd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcaae3d7-7eb7-4afe-b3ba-4550a3007c8b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c6db1a-2392-421b-9146-19cfc2966535", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "980a19b4-964d-4f6f-b87c-9b7881c8a6ee", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac4a3cd-bbee-44ba-98c5-378febd8ca5c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bb4d4c8-58d0-4905-89b8-e55039d64762", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a3ec209-7082-477f-a958-b181d0ffd586", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea1af8d-e1ff-4b19-863c-69f0bca7593f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5859dd-a487-4bbd-8bcf-d1289edf08df", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf3636aa-8731-443b-a08c-013be83c4203", "name": "Retrieve an Affiliate Custom Field Tab", "request": { "name": "Retrieve an Affiliate Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Affiliate record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9eab955b-74dd-4ac7-a31b-31c251d90a39", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c777411e-1c78-4e7f-9558-5e237ae84f25", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ec8362-0840-44cf-9dd1-678ff11b5e1a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4ecb41-ec93-436a-bf93-510363803c17", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3def973a-5530-456c-9094-362dd233295e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe113d6-bb10-439d-9fdb-d3eae74a9d97", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f4782a-5207-4960-b835-793a89128a80", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e4d523-5596-4a00-b3b7-c190f1855d76", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6def9f2-d0b4-4a52-b0e8-9860095ae815", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f05ecb7d-bdbb-4150-be43-8ecd11d8059e", "name": "Delete an Affiliate Custom Field Tab", "request": { "name": "Delete an Affiliate Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "782fdfb0-ea20-4f75-98a9-be85a6590997", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26036264-e397-48a8-abef-1669cc355ca1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2df832fc-d08e-4922-8e3d-ad28a33402e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a51997c-da66-453e-9e80-4d579533e440", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "980ce16e-602e-4033-9320-e4dfee111113", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84ad1f74-24ea-4e02-94c1-7e5d70120741", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee568f72-31f5-451c-bc64-38074a767ec6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44468a3d-57f5-4014-bb12-642a9155b8c6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df02ce0-0e1b-413c-812f-d32b96efa07a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9620d534-151c-4c61-b3de-1cf7ec1270e3", "name": "Update an Affiliate Custom Field Tab", "request": { "name": "Update an Affiliate Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "be91ca6e-b8fa-4847-aa0f-466b885f96a3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "579233a4-8ed2-4342-956b-ae557c349535", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a69c9928-e005-4ef3-995b-2933efe97bc8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b6d168b-b8e0-470b-aff7-a9e330bf34bd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db218073-9a9b-45aa-b2d8-99e35fcdcd58", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e24df2b-e676-4494-9541-2a5c414fedb9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5264e640-95d8-47ed-b521-5933b0efa09e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c0606a0-1d1b-4c1b-a32e-6a32eeb9c2f6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c63a6be-2bbf-4b06-83a2-0ff47be7d914", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11ac9718-8d57-480e-8e65-ab83277524ba", "name": "Retrieve an Affiliate Custom Field Group", "request": { "name": "Retrieve an Affiliate Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Affiliate record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "58bb80f1-203b-4dc8-932d-6694e48176b0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44837407-32b2-4747-aff7-0cb437e2b633", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6420af45-afb3-4fa5-bf6e-2a51cd428028", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dc53831-83aa-42b7-825e-984bf23be552", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbbd831c-7a7a-47ed-9f35-65550e053db3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6b41e0-cb47-467c-ae2d-6fd5e8b04449", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5aff08b-44af-46de-a1ba-2a47e271e0ee", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85cd6681-4f91-444f-905b-46a3b438ae02", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c334433e-a8ae-4318-9d37-4f89ae4f3d9f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0f38b7a-90cc-4e6e-9b41-9eecbfad30eb", "name": "Delete an Affiliate Custom Field Group", "request": { "name": "Delete an Affiliate Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8f59eecb-363c-48a7-a9db-6a6ee2767679", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88ff78fb-e32d-41cc-89ec-fe35a7115319", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e7c9b58-0e2f-4f88-a66f-f79655d8b136", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd3911c-1039-4dbc-b724-26e9ff5b9b90", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3741dbc6-8527-4b34-a49e-d7551c4e37dc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fffbccd-ad71-47e5-8c5f-c7ba1eb074dc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b38dbdb-541a-418c-baa8-9ca15a16d776", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc2a959-cc3b-4d37-b323-ec4797bfff9c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec5068b1-64a2-4292-af6a-78302b87f358", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "136930b5-5d1a-4cf7-a335-8a16df3c73af", "name": "Update an Affiliate Custom Field Group", "request": { "name": "Update an Affiliate Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e61245d2-f404-4474-bfb6-6583f6ed3849", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93156dad-30d8-4501-81cf-025903d50e4f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d757006-995a-4059-ba57-595a725a02b1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb6d706b-ed5a-4181-94bd-d246bb09d130", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9be4bce9-e3e9-4507-acc8-7ce44722bd63", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907b17c9-34ee-4758-8d7c-919164315eae", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a96433c1-0512-4590-bd9d-e11c4dae2e3c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9903d964-68fe-4357-9c73-deb86ac22080", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11de5a9b-e02e-4a25-803a-6b51f5805a76", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb2d62f7-455c-4a42-94ac-4158b12d73ce", "name": "Retrieve a Commission Program", "request": { "name": "Retrieve a Commission Program", "description": { "content": "Retrieves a single Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7eec4128-d89a-4392-aac3-315241899909", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"commission program\",\n \"priority\": \"string\",\n \"notes\": \"notes for the commission program\",\n \"create_time\": \"2019-08-24T14:15:22Z\",\n \"affiliate_ids\": [\n \"string\",\n \"string\"\n ],\n \"default_commission\": {\n \"payout_type\": {\n \"value\": \"\"\n },\n \"dollar_amount\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n },\n \"unused\": {\n \"value\": \"\"\n },\n \"level_1\": {\n \"value\": \"\"\n },\n \"level_2\": {\n \"value\": \"\"\n }\n },\n \"product_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af9c87cd-0583-4441-87b4-be9e12d4f963", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d03b171-1315-4f07-99b4-823f0cf5ee53", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7b933a-5438-4deb-8ebf-ef25143da225", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0db09de5-511a-42eb-b0dd-f3c20a7de67e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e592604b-d460-4764-b979-53edd739ba4c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0323ddd0-abee-4266-b98b-484fdae78947", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4901cc8f-756c-4467-aab7-d887fd3126b2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cd4fa2-5106-4134-a5f1-d5173069f51f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbc4970e-f073-4d66-928b-5f1662a0f7c8", "name": "Delete a Commission Program", "request": { "name": "Delete a Commission Program", "description": { "content": "Deletes a Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e99cc0e2-7ec4-41ff-863f-75150798982b", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ad444cb-8d97-4269-9ebe-c70c63250c2d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58f4b6d-d422-4b41-8e7c-6b2a9a79213f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fe553ee-2d48-499a-8ac0-d8976a01ad7a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6930a690-2f8c-4c6b-94cc-e061225c7f6f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e104d3a-3c37-4cc6-800a-1efd618cd9dd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57fb2608-22aa-4970-8556-377204880c01", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "895175d6-43fc-4df4-8331-2a894453d714", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97a61f83-3c44-45d3-842d-7b8b952494f4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dba5645-e3af-4083-9cda-5957b863b709", "name": "Update an Affiliate Commission Program", "request": { "name": "Update an Affiliate Commission Program", "description": { "content": "Updates the properties of an Affiliate Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "priority", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d05aab8-bd02-4ee2-bdea-88b069fb9352", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Gold Partner Program\",\n \"notes\": \"20% commission on all sales\",\n \"priority\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32860c2f-25a0-486c-8a86-ab82678e81b1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ca019ce-111f-4626-9839-e27b9d052807", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7b7ae97-69a2-4d95-bce8-6bc0dab4bbf9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fcc5b01-65ba-4b21-ada0-9a996b1e1a0a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca232a9d-8213-4557-9b31-8c3a129fe627", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0137ae30-1290-4afe-bc49-e1c2949dafea", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a075763-9203-4688-95e4-92b1a31050e4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3cc987c-6cfd-4233-90bd-9153521a67c1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5e7910-4d2d-4124-8315-f35ceb622fef", "name": "Remove Commission Program Resource", "request": { "name": "Remove Commission Program Resource", "description": { "content": "Removes a resource from a commission program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c9d9c21d-a918-4151-b3ec-93c32d24ae23", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5fdc8af3-49c3-4fe8-808e-94fb264e7b35", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e04ca5d4-f430-444a-92a7-a7539d4699a3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "366c62ac-21a2-4952-a483-a903d2aff098", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1fed6d1-66fc-4e7d-b7fe-84951f079a43", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7acf929-3641-4d8b-a5ca-ce66c98bc178", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51cb3c2e-49a5-4473-84d2-0177eeaee8d5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf83641-260e-4482-ab6a-2333fdf4c2f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee1b7eb4-a8c0-4443-a5c7-75c7d07f8c70", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "501e4f9a-8a57-4376-b344-ecd1d38ee9a2", "name": "Update Commission Program Resource", "request": { "name": "Update Commission Program Resource", "description": { "content": "Updates a resource for a commission program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "url", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "commission_program_ids", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da4064e6-8b9a-49b2-bda0-c671ab8418ac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Summer Sale Banner\",\n \"type\": \"BANNER\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_programs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3097b44-00e3-4e3d-acc6-37b245a153c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ca8f216-d29b-4f76-ae24-14b97fadeda3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c8f41f8-60ea-4a19-a6bc-e1d7b18e76d2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abae45a8-7a8d-4706-94cb-9c8ae8686e31", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97895705-769d-4eb0-997e-7ca21d6c28ac", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e4ca9da-5903-4784-8dd1-865b8f13252c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "035b2218-4c68-4ef8-9a27-71b3fae9f806", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15ccc020-608a-4fe9-a2fd-8c027978efa3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "page_width" }, { "key": "update_mask", "value": "commission_program_ids" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "resource_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Summer Sale Banner\",\n \"notes\": \"Use this banner for summer promotions\",\n \"url\": \"https://thryv.com/banners/summer-sale.jpg\",\n \"order\": 1,\n \"content_html\": \"

Summer Sale

Get 20% off!

\",\n \"page_width\": 728,\n \"page_height\": 90,\n \"commission_program_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "587b537d-bf93-457a-b742-87c44dd30481", "name": "Retrieve Affiliate Commissions", "request": { "name": "Retrieve Affiliate Commissions", "description": { "content": "Retrieve a list of Affiliate's Commissions", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `since_time`\n- (String) `until_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=since_time%3D%3D2024-05-21T23:00:00Z%3Buntil_time%3D%3D2025-05-21T23:00:00Z`\n- `filter=until_time%3D%3D2025-05-21T23:00:00Z`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `invoice_id`\n- `time_earned`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "590ccce3-d61a-4894-a3f3-dd44f1ab2c9b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate_commissions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\",\n \"clawbacks\": 50,\n \"commission_total\": 150,\n \"amount_earned\": 200\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c316fe-4990-448d-86f2-7ba93b1185a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9311aa58-8e1f-4b9c-adc3-847a7a546184", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bebd331-6825-4570-a0ee-96ac340a3f49", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b916485d-cb90-44ce-a863-960a7c7c333b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db2388d2-d385-4e5c-bf52-a32353becab7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b2dbe2b-7644-45dc-bfa1-c6dbbe89e25c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ae43c0-eb3f-4c4c-9a50-ec5549890e88", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507cd586-d9ee-4eb1-8003-cabca0b7e2d2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "{{affiliate_id}}:commissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ab04adc-2e1a-4630-a96c-cc9f4fb78408", "name": "Retrieve Affiliate Referrals", "request": { "name": "Retrieve Affiliate Referrals", "description": { "content": "Retrieves all referrals belonging to the given affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `source` - Wildcard matching allowed\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n\nFor the filters listed above, here are some examples:\n- `filter=source%3D%3DEmail Marketing`\n- `filter=source%3D%3DEmail*` (starts with \"Email\")\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `referral_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a1eb1cc7-994a-4d7a-abda-e72d469f7160", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"referrals\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717b07aa-1db7-47e0-b6ec-13bf8f64f3aa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8208b6c8-4b01-4723-aa4f-893344cdffa6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "576003ed-926a-4c41-86ad-ac5418594185", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6ec5b3-adb6-4880-9e0e-c04c7934ba52", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10577410-7863-441f-bb3d-5edebddf3027", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061f476f-b1ee-4f64-b3e2-ac6c1bc745d9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6419ad06-4336-431f-8c46-aa6ed883867e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c02c8eef-a29d-4beb-8a09-965f72e42d84", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfaff0b3-37ca-4fdd-a73a-f4e5f547dda6", "name": "List Affiliate Payments", "request": { "name": "List Affiliate Payments", "description": { "content": "Retrieves a list of affiliate payments", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `since_time`\n- (String) `until_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=since_time%3D%3D2024-09-17T-15:50+00`\n- `filter=until_time%3D%3D2024-09-17T-15:50+00`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `create_time`\n- `pay_date`\n- `pay_amount`\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f9204e42-d3bb-473e-b628-edce33c1a650", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate_payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c97d7eb3-82e9-4f9c-806e-fee7849d1c29", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf3a1aef-8f9b-4e63-984e-588d4dabc362", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f9c3a8d-47bf-483b-af1c-4149a66ccf77", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b407748b-4a80-42e4-a1b1-d05f24fd4280", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8be8b25a-fc8e-4b3d-9afc-bde657b2aaa9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "340d28ab-cf26-4fa2-96fe-3c469dad5aa9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb711b2-9334-4faf-ac50-090897ef9766", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc7dfb77-ed22-42fe-8270-02f135be4ac9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe1d3ac0-f0a0-46a7-acd9-1e7a1209ff07", "name": "Retrieve Affiliate Commission Earned and View LedgerURl for portal", "request": { "name": "Retrieve Affiliate Commission Earned and View LedgerURl for portal", "description": { "content": "Get the Affiliate Commission Earned and View LedgerURl for portal", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f1e491d1-ab29-4597-bd50-c7c714235ea1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate_commission_total\": 1250.5,\n \"view_ledger_url\": \"https://app.thryv.com/affiliate/ledger?affiliateId=123\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30220f59-7bc4-4889-966b-540f78406074", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2c7a8f-f8a3-48e6-9421-b334ad49951b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c54673-9e45-40ad-b342-13908db835d6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18137f5d-684b-42d6-8cdb-5f859b5a0b3b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10229948-4a95-4c2c-aeed-28239b23fcfb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d20d9d-6715-400d-bea2-01d08590c30b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0c28fdc-69ee-4fcd-bb17-ba0260e176d5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea038ca4-8b64-4bf7-a0c5-f7bc1ab9aba2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":affiliate_id", "commissionTotal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "affiliate_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "180b4910-d8ac-4eee-bbc2-ab0dc8765a0e", "name": "List Affiliate Summaries", "request": { "name": "List Affiliate Summaries", "description": { "content": "Retrieves a list of Affiliate Summaries", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (List[String]) `affiliate_ids`\n- (String) `since_time`\n- (String) `until_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\n word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n - `filter=since_time%3D%3D2024-09-17T-15:50+00`\n - `filter=until_time%3D%3D2024-09-17T-15:50+00`\n - `filter=affiliate_ids%3D%3D123,456,789`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `affiliate_id`\n- `amount_earned`\n- `balance`\n- `clawbacks`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "db5e9c0d-085e-4c18-816f-46b4f12cfba4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate_summaries\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d47dc45-0671-4554-8321-b68e11ea28b3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea912071-1c47-493c-83a6-e8c832add215", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "097f43d2-d248-4238-aa48-423331b11239", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55cd4089-bb37-480e-ab76-37d06bf72822", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0866094-c7b1-46af-bb1b-2c0b80bdb446", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "538ebfb7-a0fd-420a-8f73-ad519f994984", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de4fe05-3db9-4779-8d59-9e7fb307c5c2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0729c57e-d1d1-4e1e-b125-241a5740f9d9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a42b411-66ea-474e-82bf-20746b710c0a", "name": "Retrieve Affiliate Model", "request": { "name": "Retrieve Affiliate Model", "description": { "content": "Get the custom fields and optional properties for the Affiliate object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6323c85a-c179-4cbf-bb52-dfc49e72a605", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a07c849-c906-4c51-a29e-57e9b61f9f50", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d1b7dc-0586-42a8-8428-58383e1cf09e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313baf12-cc1d-425c-be09-d92cbefebb37", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdfe98b3-a25f-41e4-b733-f23127c5d7ce", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f86c362-da37-4663-8989-aed0f7225565", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c31946b1-4e90-4389-9782-f6ddef94dcb2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec0bfd32-b243-4152-b844-690ef6ff7b7d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaaa2651-ecac-474a-abae-8574917a75ec", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e41f9e7d-99c7-4b89-b807-2c5be902796d", "name": "Retrieve Commission Program Resources", "request": { "name": "Retrieve Commission Program Resources", "description": { "content": "Retrieves resources for a commission program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0de87824-9856-43d2-b517-2567684645f3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"resources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a923f8-a50c-4946-b731-241dd5f2787f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07af3c6e-f5f2-454a-9fb6-4dfcfe5dd35d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c36cef-f318-4fc3-9554-85e9cf2dd5be", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39cd5de4-28b3-45e9-8761-e05dce9d9aeb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f2ca02-7480-4a81-81c3-6c5ae74e4b57", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6996690-d60f-4e6a-b03d-4edb6970689d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d35d34a-3c20-4607-941f-8549c0338c75", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81387499-8665-4642-8f36-62893c28626d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id", "resources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f3ad6d5e-cde0-4b95-a98a-b59985ae7d92", "name": "Automation", "description": { "content": "Automation endpoints.", "type": "text/plain" }, "item": [ { "id": "834068ef-df40-4e6a-a5d7-cd1a6a0cc2af", "name": "Unpublish an Automation", "request": { "name": "Unpublish an Automation", "description": { "content": "Unpublishes a single automation", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "947a53f5-f343-48f3-bcd5-f33fd3fa1848", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b39a2c9-c58c-4702-838a-e63ea6fbf5ce", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "272135f9-7566-4ba3-86fd-67a6234c3c65", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045611ed-492e-4894-a48e-d0923923cad6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c6ea621-9600-4583-8814-3ebe2ea33cb3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d82987-0279-441c-80e7-9984053f851c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c5d584-620d-474f-9f68-14f9dbed67f3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3406d5-f2b1-4d12-bc06-3ecf9cf27432", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "432a6340-8cc2-4f9a-87c1-2435809b9878", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "803a7cb7-752e-4bae-a9fa-63b899554c4e", "name": "Add Contacts to an Automation Sequence", "request": { "name": "Add Contacts to an Automation Sequence", "description": { "content": "Adds a list of contacts to an automation sequence\nResponse contains a map of the provided list of Contact Ids and their individual result.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba25c839-a2ab-4f8a-8dc2-792bb1be59dd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"add_to_automation_sequence_results\": {\n \"key_0\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfb1d7e1-d90e-4e06-9dd9-0a6047cf490e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9da5e810-37b6-4512-aa3c-124621cec55b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7b9e037-e30c-4fa2-a786-54013f6de434", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32e04cda-fb10-4a4b-a199-55cc19445a88", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998c6204-e3a5-4ea6-9fea-6099136fd08d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b473a62-9159-4f16-a385-e03bb4e95427", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b314bf-ea7d-4e3c-b26f-78b1e167e569", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df681865-449b-4abf-b47f-3c1dbe028ff5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7c04385-0940-4d3c-a749-76fbbd17c3d4", "name": "Achieve an Automation Goal", "request": { "name": "Achieve an Automation Goal", "description": { "content": "Achieves a goal in an automation for a contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a87e671b-4db4-4683-9c86-cc9ebfac03db", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f5175da-79d9-4a93-a793-0bc77443e3fd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c953f077-b318-4bce-8c29-62bc94bf08ef", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6296f30a-16f1-4e8f-92a3-d4f3b753dda0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ae905f0-a266-433b-83a2-ca8778c6c7ee", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a7f386b-9234-448f-bd35-0607e6327c7b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d63042e-c3c7-41aa-b435-fc03a8cee514", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b4d082-84fd-4729-b734-e3e238307bac", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27283c2-94e9-4825-b4b8-250bd38e3ba5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "goals", "achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": 789,\n \"integration\": \"my_integration\",\n \"call_name\": \"goal_achieved\",\n \"automation_id\": 123,\n \"goal_id\": 456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c8b919d-447e-48b4-a208-6e742b6991ca", "name": "Bulk update for Automations Categories", "request": { "name": "Bulk update for Automations Categories", "description": { "content": "Bulk updates the categories of one or more automations", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30b20dc0-b2bd-4bbb-a7c7-ec8157d3fd83", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15279820-34ac-48f0-9029-6c646fb004fa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9b2b09c-07f5-4ee0-a9fd-cbe803f5010e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2733e82a-6514-4e0a-86ba-d8741c7f7e49", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45cfd745-681e-4e37-93c9-3ba3bbfb9875", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38b23d6a-370f-4f75-8444-4a762665e791", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07eb75e5-eedc-45fa-9045-1209c4e1734e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a10b28-e91c-42fc-b7be-9466ef8acef6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8f8e00f-e1e6-4519-ad8c-7eec858168e4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "categories", "batchAssign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"automation_ids\": [\n \"100\",\n \"200\",\n \"300\"\n ],\n \"apply_category\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "546bcb78-663b-4bf4-907c-05db8be62e4a", "name": "Bulk unpublish Automations", "request": { "name": "Bulk unpublish Automations", "description": { "content": "Bulk unpublish one or more automations", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e87fe210-c938-4963-8442-98cc0fe4905f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "031f528c-f48d-4509-a315-51b5e7a8933a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d6e856-c983-44e9-8f42-75b25b1b7eb8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9367e663-4091-48bb-9a2d-0b5bd847a372", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "128677a7-b70d-40c5-a85b-9f127d05da0f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6803ee76-ebaa-4b5a-b0e9-a54892dc6a33", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b838f99-72e6-4e13-9e8a-ce5d774163b2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c6f9f99-4367-4f69-b65b-12b9c1230cf0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "166d1cf9-b27b-4457-8c11-f966836c085f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "batch-unpublish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"unpublished_form_message\": \"This form is currently unavailable\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "178cb8e6-ad4b-47c3-8f68-812cbf611dac", "name": "Renames an Easy Automation.", "request": { "name": "Renames an Easy Automation.", "description": { "content": "Updates the name of a single easy automation.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56bf9dfc-5ffa-4ed9-bf76-1c486a3bd415", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1adcb7d-5486-489c-b4a9-424ce2689c6b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c58c594b-8696-42fa-8d38-85013dd0e4ed", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d472e4a4-e1cd-4b79-90b5-11d03a3322e7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1fa18eb-3485-4aff-9fdd-613f07f6c8d3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3f1133-c1c7-4916-be0d-df609de84ffa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "693fa3e8-e207-4f39-b4aa-ada6bbf74671", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54db61d0-c66f-443d-b534-f202a74c5531", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75d8b261-0548-4327-9ed0-ec114c6eae7f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "easy-automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "HWv0fbDNDbWg6cFKY027", "key": "automation_id", "description": "(Required) automation_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Welcome new customer (Fall 26)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fb39293-7605-440e-aaf8-b4a07de856b0", "name": "List Automations", "request": { "name": "List Automations", "description": { "content": "Retrieves a list of automations", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- `name` (String): Filter by automation name. Supports the `==` operator with optional prefix wildcard (`foo*`).\n Without a wildcard, the search matches automations whose name contains the given text.\n With a prefix wildcard, it matches automations whose name starts with the given text.\n - `filter=name%3D%3DSpring Automation` — names containing \"Spring Automation\"\n - `filter=name%3D%3DSpring*` — names starting with \"Spring\"\n\n- `id` (Long): Filter by automation ID. Supports comparison operators:\n `==` `!=` `>` `<` `>=` `<=`\n - `filter=id%3E5` — id > 5\n - `filter=id%3E%3D10` — id >= 10\n\n- `status` (String): Filter by automation status. Accepted values: `published`, `draft`.\n - `filter=status%3D%3Dpublished` — published automations only\n - `filter=status%3D%3Ddraft` — draft automations only\n\n- `categories` (String): Filter by category ID (comma-separated list of IDs).\n - `filter=categories%3D%3D1` — automations in category 1\n - `filter=categories%3D%3D1,2,3` — automations in categories 1, 2, or 3\n\nMultiple filters can be combined with `;` (AND logic):\n- `filter=name%3D%3DSpring*%3Bautomation_id%3E5`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `category`\n- `activeContacts`\n- `publishedDate`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e3ae35eb-a1d6-41d1-ac6a-2d88277c3361", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"automations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\",\n \"automation_count\": 7775\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c1fe833-86f7-46d1-966a-66c1bc9e57cf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1848e6a-a872-4c0c-9dc6-9763dfac904f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0447bc24-5eab-41fb-9516-bc93ebcd33ba", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2884f6e-5fbf-4da8-af70-931690b63e23", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3f0cc3-9a9e-430d-a806-2ad0082557a7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2266ce-69b9-4b83-8610-96e0416e7a29", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37a469cd-a2d4-4c1e-9b7d-1bc67de005ca", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a8be5c1-c3f8-44ad-a50e-ed7c79129371", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e12d32f-1ddf-4f46-a01c-df896ea832fb", "name": "Delete an Automation", "request": { "name": "Delete an Automation", "description": { "content": "Deletes a single automation", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "automation_ids", "value": "2402", "description": "(Required) " }, { "disabled": false, "key": "automation_ids", "value": "3659", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "87eca8b1-bece-465f-9d31-72974500582d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8f6f9df-67d6-450f-82a6-5839639a70cc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ee979e0-9e51-42a3-a241-2a2736cfe1d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eefebf97-d16b-4bc5-93ab-a2e706ac0550", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "185ad7d6-19eb-4917-a03c-79e0a5dc8426", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed4fed46-cb70-4e6e-9daa-6545d4dba75a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8be67108-bd58-4aca-a139-d1926d28f04b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9db4938-405e-4c30-b1f3-b691462a992a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "390bcc58-efaa-4297-97cf-0c4c9479fba3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "4329" }, { "key": "automation_ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7aa601b-ecd4-4124-86f3-b1f2bd8e1637", "name": "Retrieve an Automation", "request": { "name": "Retrieve an Automation", "description": { "content": "Retrieves a single automation", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6e5375b9-191f-4188-98bb-96cb00d643de", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Welcome Email Sequence\",\n \"categories\": [\n \"1\",\n \"2\"\n ],\n \"status\": \"PUBLISHED\",\n \"locked\": false,\n \"active_contacts\": 150,\n \"error_message\": \"Invalid email template\",\n \"published_date\": \"2024-05-21T14:30:00Z\",\n \"published_by\": \"string\",\n \"published_timezone\": \"America/New_York\",\n \"current_edit_lock_status\": {\n \"locked\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n },\n \"user_name\": {\n \"value\": \"\"\n },\n \"user_firstname\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d4bec40-9205-4854-a9c5-452ab40e5f20", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92d4c39e-7a3e-43a6-99d3-b13aa596fd2a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cc2aa1a-aa23-422b-a4d8-f38d9a38ca59", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b59cf1-4e4f-4291-8b20-f2c6010b85e3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d53c27b-1bb8-4422-8d02-ebcc54c46a38", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3be6a8b3-18fd-4f63-adc6-f109b434e5b5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c11d8d5-9b10-4f24-baaf-c2f042313cd2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3636869b-5f9f-44be-b2e9-db0dba2a962b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "259d6616-f7d5-4f9e-b0e6-6f7d6b87afda", "name": "List Automations Ids", "request": { "name": "List Automations Ids", "description": { "content": "Retrieves a list of automations IDs", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- `name` (String): Filter by automation name. Supports the `==` operator with optional prefix wildcard (`foo*`).\n Without a wildcard, the search matches automations whose name contains the given text.\n With a prefix wildcard, it matches automations whose name starts with the given text.\n - `filter=name%3D%3DSpring Automation` — names containing \"Spring Automation\"\n - `filter=name%3D%3DSpring*` — names starting with \"Spring\"\n\n- `id` (Long): Filter by automation ID. Supports comparison operators:\n `==` `!=` `>` `<` `>=` `<=`\n - `filter=id%3E5` — id > 5\n - `filter=id%3E%3D10` — id >= 10\n\n- `status` (String): Filter by automation status. Accepted values: `published`, `draft`.\n - `filter=status%3D%3Dpublished` — published automations only\n - `filter=status%3D%3Ddraft` — draft automations only\n\n- `categories` (String): Filter by category ID (comma-separated list of IDs).\n - `filter=categories%3D%3D1` — automations in category 1\n - `filter=categories%3D%3D1,2,3` — automations in categories 1, 2, or 3\n\nMultiple filters can be combined with `;` (AND logic):\n- `filter=name%3D%3DSpring*%3Bautomation_id%3E5`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `category`\n- `activeContacts`\n- `publishedDate`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "007566c5-a468-4cef-b098-5abded456551", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"automation_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ],\n \"next_page_token\": \"string\",\n \"locked_automation_ids\": [\n \"456\",\n \"789\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a216705d-67cc-4f02-b3c9-42c8b5e11889", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7180ab17-05a9-4634-87c9-1a03c7e00dff", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44766e95-c232-4ff3-968d-3ab1aa3bef40", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f00cb6-a78d-4b6a-adaf-a3c1d3e53623", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e461c7e8-be4a-4a8c-acaa-fafaf091caf0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aae0bec-a7d4-49d3-9ebc-88b0226e892a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425e836c-e9c2-4d7c-a42e-e2fc3ea82741", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bea424f-6485-4c35-a2a1-90623d041075", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", "ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "04e8c114-740d-4898-b8f0-de89674c2a77", "name": "AutomationCategory", "description": { "content": "AutomationCategory endpoints.", "type": "text/plain" }, "item": [ { "id": "f060b150-64d3-4181-9ca1-686de5d8d597", "name": "List automation categories", "request": { "name": "List automation categories", "description": { "content": "Retrieves a list of automation categories", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f307dcad-0895-4e3f-adca-33e9b56337e2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"automation_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a032b93-41f7-41de-bd5a-cde33096dac6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19789de-199f-470b-bd82-35b8f8ead538", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3fd253-a0ce-4cfd-a7f6-bea72b012c9d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98785f62-4737-4a81-b0e7-a687ab2ff8da", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0065fab9-d5fe-439f-b123-2a06165b6e0b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa6dbd40-952f-4491-94ad-a783fcad0c76", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad033167-3520-49e9-9023-ac5ba891df25", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a118812-2b30-4092-9d6c-084f9c86c23d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da17bfb0-bde0-4bb1-b8b1-d4c8852fc124", "name": "Create automation category", "request": { "name": "Create automation category", "description": { "content": "Creates a single automation category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "337d2fb4-7419-48ed-a3a6-6f4e623f6e67", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Marketing Campaigns\",\n \"automation_count\": 15\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb2320af-be15-4dee-85cd-8815969f7438", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e258254f-6293-4d56-88f7-cd25e8541999", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bd182cf-2e3e-4bff-b0b5-83f58e088207", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "accdeccc-2cc6-4880-9357-c246337565b4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc541558-8769-4742-9767-c6d4103eac8c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99c6a4f8-842e-4782-af1c-314ba28c3b93", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfeae3d4-4ae0-4d7c-9d78-747edf4f733d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e50cd3-c694-4a08-a4db-bdcba3af53db", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a6c7468-57db-4a93-b9e8-b9520119ffae", "name": "Delete automation category", "request": { "name": "Delete automation category", "description": { "content": "Deletes one or more automation categories based on the request parameters", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "2402", "description": "(Required) " }, { "disabled": false, "key": "ids", "value": "3659", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "292269ff-c243-4337-841f-c326f57e7065", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2ee83b7-7ab4-4035-a0db-49a04e6a70fc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7379838-cf91-4af8-8755-031d5cbec4f9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2e36c9-d7d1-424b-a272-6d3c387fcd82", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e5379c6-f394-4483-8084-4f9d0fc9e06f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a38e33a2-f00c-4fa3-beaf-cf49d5c044ea", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb5a832e-f6fe-4523-a330-a48a58dc1ce3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b9ac45-ddc4-44e6-8c7a-858e2736f237", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ffb8d57-678e-4251-94fc-bba54e53ef87", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "4329" }, { "key": "ids", "value": "4098" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ca19758-5ba3-4573-901b-720cc3d165e6", "name": "Update automation category", "request": { "name": "Update automation category", "description": { "content": "Updates part of a single automation category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "24364e08-6b6d-4446-bb49-6526d5960548", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Marketing Campaigns\",\n \"automation_count\": 15\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efe332a-9a81-41ed-891c-c8f315cf5b24", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd0f6a97-b416-4c4e-9fae-1fe3a3ceaa9b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bbf0a52-8ba9-4897-a88f-165ed8995b91", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b2cdac-9a34-4c29-b729-6550a103a302", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61eb98a2-8c8d-457b-b5b1-d312fb75c563", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3fbc4df-9914-49c2-a6bd-05f417fa9c4f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1cbdd1e-56d6-425e-b08c-37ddfc417083", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2499d460-1a6c-4127-be73-eb0c4b088acc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Marketing Campaigns\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "941e78b5-0efc-4c19-ac0f-a549e1d28964", "name": "Business Profile", "description": { "content": "Business Profile endpoints.", "type": "text/plain" }, "item": [ { "id": "e6f9a62b-a58c-4180-b262-008564c92e03", "name": "Retrieve Business Profile", "request": { "name": "Retrieve Business Profile", "description": { "content": "Retrieves Business Profile information.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "13eb51c1-d93b-4342-b41c-83400b147fca", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n }\n },\n \"time_zone\": \"string\",\n \"logo_url\": \"string\",\n \"currency_code\": \"USD\",\n \"language_tag\": \"string\",\n \"business_type\": \"string\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c36a5d-3326-48c2-9b12-64a36f8e1e25", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d326534-32cb-4c47-aff7-bef1a7a1c536", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c45da5c-69a2-493a-b372-a68fa28c18ec", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25187460-f4d2-4bef-8012-d1ed22026949", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7630b325-52e4-42e5-a742-265b84cef880", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9df01b1-81e7-4723-9972-346776dcf479", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a5c08ff-2a9b-44a2-886b-73b620664eb4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8541f752-bbce-4fc7-b56e-308fb6dfbf63", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c17ff94d-44c2-4ea0-b416-efe0f21c2ea6", "name": "Update Business Profile", "request": { "name": "Update Business Profile", "description": { "content": "Updates Business Profile information.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "business_secondary_color", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "phone", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90443394-0b66-4c18-bf1c-434d4d49a38b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n }\n },\n \"time_zone\": \"string\",\n \"logo_url\": \"string\",\n \"currency_code\": \"USD\",\n \"language_tag\": \"string\",\n \"business_type\": \"string\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9dab1b3-52bc-45bb-8b2d-f0ee040fc1a7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2217433-b71b-4fb1-a841-ce5d318248c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04af5d69-52dc-4182-983b-e4f123925d35", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac40e930-dedb-49bd-9289-e459a9aab2b8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d7e1ca6-3a4b-4df9-aa63-686066c2d429", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ecf36f0-9fe0-48d0-94b4-44ab0f5af701", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3136bbd6-566f-4f73-a68e-59ba7d986cbe", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edce315f-79aa-43f8-bc08-a9a458f775fa", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_secondary_color" }, { "key": "update_mask", "value": "currency_code" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"phone\": \"string\",\n \"address\": {\n \"country_code\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n }\n },\n \"currency_code\": \"USD\",\n \"business_goals\": [\n \"string\",\n \"string\"\n ],\n \"business_primary_color\": \"string\",\n \"business_secondary_color\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c4e5149c-5007-457c-b4d1-f451492a30a5", "name": "Campaign", "description": { "content": "Campaign endpoints.", "type": "text/plain" }, "item": [ { "id": "7634f68c-4fca-44b0-a16d-adc7a2c291af", "name": "Remove Contacts from Campaign Sequence", "request": { "name": "Remove Contacts from Campaign Sequence", "description": { "content": "Removes a list of contacts from a campaign sequence\nResponse contains a map of the provided list of Contact Ids related to their individual result.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c458ac25-f088-4314-8c9a-ed2d7ea3895d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"remove_from_sequence_results\": {\n \"key_0\": \"SUCCESS\",\n \"key_1\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_2\": \"FAILED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c451f1c4-4976-415f-b482-72e6177e6b7c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5492b149-85fc-490e-9edb-add15da8d4ff", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef657960-e0b4-478b-a7cd-89931075d98f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b6d563-a010-49d7-8ace-75b770f7360d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a67fce-8671-4cab-b88c-aead12c44221", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a7c5305-9d80-499f-ab47-afac9e99578c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35e4e58-f920-46f0-b825-1b9ac3ab00d2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8167fe45-d685-4758-95ea-6deef9356f4b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:removeContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01f91794-3acb-4ed6-a981-10af08254187", "name": "Add Contacts to Campaign Sequence", "request": { "name": "Add Contacts to Campaign Sequence", "description": { "content": "Adds a list of contacts to a campaign sequence\nResponse contains a map of the provided list of Contact Ids related to their individual result.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "914dc19e-2bd3-401a-8a96-b2095cd750f2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"add_to_sequence_results\": {\n \"key_0\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8e939df-37d8-45ae-b956-c469653392d0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28dd435b-c80d-43aa-ab70-215325fc6d31", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e32f15ac-3899-4ffc-a600-a12a99430e8c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55570c4b-368c-4af3-bb72-5d404648900a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "effc5f8d-3502-4072-9e4d-4652e67d89b1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e1dbc4-a269-4d50-8e18-248c1a9d569c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72dc19d4-bf1e-474a-a7df-4101bccbf4d5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fc2d48b-335e-4784-acb3-e3255474b207", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d635f510-f818-467a-8821-bbd6b84914c5", "name": "List Campaigns", "request": { "name": "List Campaigns", "description": { "content": "Retrieves a list of campaigns for the authenticated user", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n\nYou will need to apply the `==` operator to check the equality of the filter with your searched\ntext, in the encoded form `%3D%3D`.\nThe search will look for the text anywhere in the campaign name.\n- `filter=name%3D%3DSpring Campaign`\n- `filter=name%3D%3DTag New Contacts`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `publisheddate`\n- `id`\n- `completedContactCount`\n- `activeContacts`\n- `datecreated`\n- `lastupdated`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "25156f21-01ec-42dc-b954-2c6849d16d3c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaigns\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "091f6ff1-ff26-4763-a9f6-22818dbfd9bd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e17c28f-f53a-4668-b0a9-745555d328d7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bc27f51-7dbb-42a5-b31c-1db771d60d4e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ce00e57-fca1-4219-98be-6ced27933ea4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f9de89-827e-46bb-8bd3-50a1968615ea", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4b95b36-9420-4094-8f0e-94284276c4a5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aced3e49-ea77-4186-a311-7442490dc464", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e4819fd-6c26-4bd9-b9ab-4bab0573c749", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7d30d70-f917-4ae7-82d0-ac6880fb900f", "name": "Retrieve a Campaign", "request": { "name": "Retrieve a Campaign", "description": { "content": "Retrieves a single campaign", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "af9c4ac5-d821-4d8d-9359-9c8c0730d5f9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Summer Sale Campaign\",\n \"locked\": false,\n \"date_created\": \"2024-05-21T14:30:00Z\",\n \"published_date\": \"2024-05-21T14:30:00Z\",\n \"published_status\": true,\n \"error_message\": \"Invalid sequence configuration\",\n \"time_zone\": \"America/New_York\",\n \"published_time_zone\": \"America/New_York\",\n \"created_by_global_id\": \"user_abc123\",\n \"active_contact_count\": 250,\n \"completed_contact_count\": 1500\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e6f2554-5cb4-4ec4-93f0-60fcf5cb9b68", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3f70ff9-2f12-4170-817d-275548090d33", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876e3301-ee4d-453c-9c38-0a03d48d540d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104e945a-8b76-45e2-ad7c-4985474724d1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d0ec18d-9bec-4bc7-9882-71892e1d2d87", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b39109b1-4eb4-4f9d-b18d-f743dcdc80ab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c58af2f-8d2a-4c4f-845b-1bcfdb060e4c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eed6e73-07a2-4a56-a13c-d172fe9b825a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bd1ff2d-ae51-4b5d-a280-be90458a1a3f", "name": "Retrieve a list of Sequences for a Campaign", "request": { "name": "Retrieve a list of Sequences for a Campaign", "description": { "content": "Retrieves a list of Sequences (published) for a Campaign", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c2b2f2a0-bfb9-40a6-8acc-90782d2db8fb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sequences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\",\n \"campaign_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46df47b2-39f8-422b-ab52-852dd30c09c6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0310c6bc-e831-4c65-a1c7-a511fc1a1979", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b79e40fc-5bc6-49ca-828a-e22db16d80f7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d001ee3e-2295-44c9-8825-3dd674896ce6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f3d4071-bd74-4211-bcff-3916c4c86661", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbae2fa7-3aef-487d-acc0-3f20a0587c8f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d408f6ed-78a8-4484-a494-71dddc0179c5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b266ad0e-97ad-4bda-8904-9676dbc83417", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "sequences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5da422ee-0e69-4dba-b28b-62bed1b5ea05", "name": "Retrieve a list of Goals for a Campaign", "request": { "name": "Retrieve a list of Goals for a Campaign", "description": { "content": "Retrieves a list of Goals (published) for a Campaign", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ee236a57-87b5-458a-a165-01c725af8a60", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"goals\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\",\n \"campaign_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d66e05-31eb-49c8-913c-cc0bda3fabe8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab501d8b-fad1-4455-9b2c-1ac3269f9a61", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90ba9156-7410-453e-ab1a-b11bca0515fe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ebfb2c1-39d8-42ed-939a-4057b7f36ccd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b52624f7-be1d-49f2-9243-50ed986a36c0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d3c9e9-b828-435a-899d-5e84ce4ac289", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "297fc30b-7e71-49d3-b703-3abd1cd315d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "012564c9-e7ff-4673-9130-7ba3028a9237", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "campaigns", ":campaign_id", "goals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "campaign_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "795b8922-d3a7-4dcf-885f-54fa21df3c35", "name": "Category Discounts", "description": { "content": "Category Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "f5f1e2f0-e837-47c1-98da-af2a0152f507", "name": "List Category Discounts", "request": { "name": "List Category Discounts", "description": { "content": "Retrieves a list of Category Discounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, the allowed field is:\n- (String) `id` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (List[String]) `ids`\n- (String) `name` - Wildcard matching allowed\n- (String) `description` - Wildcard matching allowed\n- (String) `product_category_id`\n\nYou will need to apply the `==` operator to check the equality of the filter with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=product_category_id%3D%3D4`\n- `filter=ids%3D%3D1,10,4,24`\n- `filter=id%3E5`\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `description==foo*` finds anything in `description` that begins with `foo`\n\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "92682b29-8bb5-402a-a506-31910ffa49ac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"discounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "728b2b09-6921-40bd-896b-f1f8376be65c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020c07b7-9054-4cdf-b4fd-d8fc417bbcdf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2846f80b-3954-4809-b53a-da0649e3cc9d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1bcd9d1-d96e-4049-bb27-4a634465dde5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae46538b-f37d-451a-810f-bed749f3db50", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8926e065-39c3-4360-b373-3dd5e16af575", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23ce1376-d4ce-439b-b60a-16c6818735b8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69af81ef-4bc4-45bf-a04d-6af03cff69f5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "946ca382-4ab7-4c54-8fac-502e860b2b2f", "name": "Create a Category Discount", "request": { "name": "Create a Category Discount", "description": { "content": "Creates a Category Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8343cee9-c816-4cd7-acb5-8875b6630aa1", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_percent\": 15,\n \"apply_to_commissions\": false,\n \"product_categories\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ecfb6d6-4088-4258-951e-7bd432ec6467", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeb17c99-9806-4f96-9c06-bbedbae8cd0c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc9b7736-7ab7-4879-8acf-5e54109affbf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bcff6a9-6774-4171-bc7a-fdb03be79aed", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b1339c4-2062-4caa-a58e-06f1df57644d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcfc279c-9182-44f3-a66e-cf10c1d3bb15", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e099cdad-4774-4aec-893d-d858a8500885", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a969b12-a138-4c98-a175-db83491dac19", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"name\": \"Electronics Category Sale\",\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ],\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5302443-2525-493e-8a0a-185046264348", "name": "Create a Category Discount Criteria", "request": { "name": "Create a Category Discount Criteria", "description": { "content": "Creates a Category Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "77e42060-a050-4f9e-ae57-4aa48737fa9c", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"criteria_id\": \"string\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac7b34a-c0ae-41c5-b3d8-d86adab11a64", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04d272ab-5b8e-4783-b73e-f542c43bcdb6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0135636b-bfd3-4a70-bb25-3d30001e70f2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dcc10d9-5faf-40ed-a069-d7c0f4403175", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5707191d-149b-4227-b68c-4249c49bf900", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc72a50-a7f3-4b93-b8b8-304847f5b299", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351d15bc-a6c1-46be-a1ed-ef54aef2f015", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c653b3-eebe-4ccb-bfd5-43a462d20ed2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "462e663b-d4d8-435e-a78a-d977934fe75a", "name": "Retrieve a Category Discount", "request": { "name": "Retrieve a Category Discount", "description": { "content": "Retrieves a single Category Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "97ab45d8-6efb-438b-96b6-14c229c058d2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_percent\": 15,\n \"apply_to_commissions\": false,\n \"product_categories\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "152ad6df-b1f9-40a1-80a3-b20be803de1d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd5d4adb-a608-4e35-93e4-5b6154d5943c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5c609f7-fc48-465c-81d9-6ad29b7db6ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4d9a590-5d9b-4a40-a84e-0b4bb4a7073a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a34de54-0bb1-488a-a52b-7c09b566cde8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f7ec68-faa6-4288-9b59-d9f18e7e3f70", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f6827b1-4bf7-47ca-911b-0e69b0e1f61d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c65268-4a8b-4bc5-9024-10d107d38c51", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41dcf382-9cc8-4160-a812-117ad2434dab", "name": "Delete a Category Discount", "request": { "name": "Delete a Category Discount", "description": { "content": "Deletes a specified Category Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "85cf20a4-cfa3-426d-9340-6018454e5668", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "218837ff-6e4c-4e99-9349-7a498ae1ba76", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30cc1d4c-25ea-4731-9681-947be45c5c0c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cb2eafe-a581-4063-8a30-75ffd91fa195", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fd5948a-b3cd-40e1-b841-21e22a1fa8e2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "680d486e-06df-4f95-be7f-cefdbd20bbd8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f351ffa5-6916-46df-a66a-7d1d482b5f15", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1b40e9d-ad90-4d70-a367-b30a82c0c810", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92cbf00c-a315-448a-b148-2ca7a7f3d5ba", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e2d2952-d8c6-49cf-b485-6673693205a7", "name": "Update a Category Discount", "request": { "name": "Update a Category Discount", "description": { "content": "Updates a Category Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "criteria", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "product_category_ids", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3dc394dc-ece5-4cf4-901a-e35436122b08", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_percent\": 15,\n \"apply_to_commissions\": false,\n \"product_categories\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e453842a-f7f9-4dde-a611-b67e79ed8e59", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "932b0532-585a-4cd9-ba42-28e19d3d1e42", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c38763a9-7237-4025-b65c-a3120a4b4146", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f507ccb-8363-40ab-9df4-48f971ed80e8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750275ec-f272-4d8e-a270-e5c120d4b312", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1813891-3d20-4450-9614-08bf1f919400", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153e74b0-1ff7-4dfd-b0c2-cb765c1debf6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d469ae76-a654-4d69-9779-97b8c720d010", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "apply_to_commissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics Category Sale\",\n \"description\": \"15% off all electronics\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": false,\n \"discount_percent\": 15,\n \"product_category_ids\": [\n \"10\",\n \"11\",\n \"12\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "378aa6af-2b04-44ca-bdd0-cbcc928a794d", "name": "Delete a Category Discount Criteria", "request": { "name": "Delete a Category Discount Criteria", "description": { "content": "Deletes a specified Category Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "eedd68c7-ef6a-4925-bcb5-c9d8164f74f7", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1584b72d-cdaa-47b1-a359-4162ef615c71", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1612e12d-b740-411e-9f11-0b8b97e09cea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00bd09fd-63dd-4bab-9a8d-f7978212cb95", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5281fb-db62-4f04-bd38-b5c4e6974a7b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9ac537-ddae-4986-a904-529ef8cb07d5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b238199-aa66-4062-ab04-f6eb12f53745", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56fa74bb-62cc-4335-831b-8097155aa975", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c5aad27-7104-4ca5-93ec-4d62bc70a555", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3acc80c0-f98c-40eb-ad03-4dce1d277c9f", "name": "Company", "description": { "content": "Company endpoints.", "type": "text/plain" }, "item": [ { "id": "11cc1f6b-1bc2-4ec1-857f-6c998476da1b", "name": "List Companies", "request": { "name": "List Companies", "description": { "content": "Retrieves a list of all Companies.

", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `company_name` - exact match on company name (equality only)\n- (String) `name` - company name with support for a wildcard at the end (e.g. `smith*`)\n- (String) `email` - exact match on email\n- (String) `city` - company city (Contact.City) with support for a prefix wildcard at the end (e.g. `Chan*`)\n- (String) `state` - company state/region (Contact.State) with support for a prefix wildcard at the end (e.g. `Ar*`)\n- (String) `since_time` - companies updated on or after this time\n- (String) `until_time` - companies updated on or before this time\n- (Number) `company_id` - supports comparison operators: `==`, `>`, `<`, `>=`, `<=`\n\nFor equality filters, use the `==` operator in encoded form `%3D%3D`:\n- `filter=company_name%3D%3DCompany`\n- `filter=email%3D%3Dtest@gmail.com`\n- `filter=city%3D%3DChandler`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nFor wildcard name/city/state search (prefix only, case-insensitive):\n- `filter=name%3D%3DAcme%2A` (starts with \"Acme\")\n- `filter=city%3D%3DChan%2A` (city starts with \"Chan\")\n- `filter=city%3D%3DChandler%3Bstate%3D%3DArizona` (combined city + state filter)\n\nFor company_id comparison:\n- `filter=company_id%3E5` (company_id > 5)\n- `filter=company_id%3E%3D10` (company_id >= 10)\n\nCustom fields can be filtered by their field name (case-insensitive). A standard\nfield above takes precedence over a custom field with the same name. The supported\noperators depend on the custom field's type:\n- Text-like fields (text, text area, name, email, phone, website, social security\n number) and single-value choice fields with text options (dropdown, radio,\n state): `==` only, with optional trailing wildcard (e.g. `Industry%3D%3DTech%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (whole number, decimal, currency, percent, year, month, day of\n week, user): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601 (same as `since_time`/`until_time`)\n- Multi-select fields: `==` matches records that contain the given option\nExamples (for a custom field named `Height`):\n- `filter=Height%3D%3DTall`\n- `filter=Height%3E100`\nCustom field filtering on non-indexed fields is supported but may be slower.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `create_time`\n- `name`\n- `email`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Company properties to include in the response. (Fields such as `notes`, `fax_number`, `address`, `email_address`, `phone_number`, `update_time`, `create_time` and `custom_fields` aren't included, by default.)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2293aabe-83ac-4fb4-91b3-afd15d17b06c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20db5c2c-9142-48de-9abc-a71225d6ea0a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b401a406-eb4e-4326-9e56-4a4ce3c7f4e5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e8864f8-82a7-4004-acf7-ce7f02082567", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3864c4-4311-48ed-8d2b-d01547968486", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a86c8c3-5094-4acb-99b8-dd68c61d835c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425151e3-90bf-4307-b213-c6a8e09e6e55", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "049ce2e0-b91e-4be3-b787-84d9d90e9be5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89487673-3c17-4e42-8eab-7192b6fe92a3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2d30ad7-e64a-4b09-80e6-3992d8a7fd4b", "name": "Create a Company", "request": { "name": "Create a Company", "description": { "content": "Creates a new Company.`country_code` is required if `region` is specified.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "568d721a-404d-4573-bf45-8d8c9f45b2a8", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"groups\": \"1,5,12\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\",\n \"account_id\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2317eb-8044-4952-a0fd-7df8daf1ac8d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d48cac28-7e06-41a0-ad4f-482fc4ac8971", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84831cc8-56eb-43e1-b3d3-b19ba103cefd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73705a5c-e79f-4f3b-b518-e7d68f38ef7e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d691e074-6c99-40b9-a5b5-c97bd4adef0e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff81df9-7c27-448e-953a-a3eaa848c838", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4ce4ce2-3986-4bf3-b334-1c80fc49d7ac", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8642f15-e00d-4a07-a723-cc4e8e108561", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a64d013c-6b7f-4246-913d-a68d95ebcf37", "name": "Add Tag to Company", "request": { "name": "Add Tag to Company", "description": { "content": "Applies a Tag to a Company.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "9633f68f-29c3-49c5-aa48-ee38d861904d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1f700bb-39bd-4abe-bc53-318ba9f721b4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13cc6b47-9da2-428e-817d-6901ab8a1b07", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05505d2a-332b-4732-a48b-46b4abc4a6c3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce57c00e-2ef6-4501-b094-171d208a27e6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab3a3a8-4d97-4e5f-b173-c3f72ad7344a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3444ec86-f81a-4079-ba1c-3f03eca8b19d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ba30295-f9d4-4e15-84aa-763c65152ae9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628567a9-ce0f-495f-bf42-152d0e8d2125", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22f682a1-ddbe-42b3-8275-bb01ded3681b", "name": "Remove Tag", "request": { "name": "Remove Tag", "description": { "content": "Remove a Tag from a Company.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a76c9b09-7405-48ce-8040-682fb628864a", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b7ac0f6-729c-43ab-b368-e900ddade98f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e58da565-8849-450c-a632-b2f5e659f06e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b57188bd-b01d-443d-87b2-33c6d96c41a1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07959e98-372f-49bf-9fee-f1e9c3bff657", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0720da6-910c-4fef-80dd-16fac325f1f1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3248219-8063-477f-9ca9-58f0b1de9685", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a94249-39c2-443c-b7a5-eac544e7d945", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716c5604-311a-4c64-8dbb-6de7529aeb66", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4f3093d-019d-4635-9b16-7119fae8b21a", "name": "Create a Company Custom Field", "request": { "name": "Create a Company Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Company object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5774048a-3f63-40f9-9ee1-b88b8f9ce26b", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7df53644-579a-4f37-8df6-f6bfcebe6b3d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b0e99b-18af-41c1-aeaa-34d9f724bd42", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4491f3fa-90e8-422c-89a5-72ea733600b0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6865d8fd-76d0-4237-bab6-d3f82b5e92b4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "806bb319-c7ac-4158-8d40-e2ebb4f3f87b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d35fadc8-0f81-45e3-adc3-2af7887c099c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f57b245-a99b-4107-b5bc-7776e2ce145f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b259a12-5b13-47a8-a934-c99e539f5d08", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1baa918-9605-493d-92fa-7b690d597898", "name": "List Company Custom Field Tabs", "request": { "name": "List Company Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Company record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "688af781-6674-4439-b1d5-c8063a4bcc4f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f73bae9-83bd-4f30-a741-08b30cfcb6a0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcec1274-75dd-4b92-854b-596191d1fabd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14f4c80-c714-482e-9107-b42297502186", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c77c68a-bee0-4a57-a5ff-c5185286957a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edebdc80-a39b-4bed-853f-20e873aeed90", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a83ee33a-960e-4f63-910b-3d13a4ece70e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eebbd400-32e9-4b4b-b8e7-b5916c3b0342", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f5f35f0-b5d1-44e5-a6b0-015b842ebf26", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2f07209-8818-4c15-828b-2538b67fc4dd", "name": "Create a Company Custom Field Tab", "request": { "name": "Create a Company Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Company record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "383c4fc8-d290-4fc4-8d4b-71f8d8ef1477", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e10cae22-d72e-4142-975f-6e402c73755d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2042917b-058e-42e6-a283-b4ac7a135f7e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f66e1aa6-c19c-47ee-a212-2c668748cfd1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e390b550-6f79-4391-b2d7-8cd140376888", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3902865a-c75a-4e76-8801-d4ad9e7d9db4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "691be5af-a67b-4147-a7db-d5bedcca0cc2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc2197e-5d4e-4ae3-89c9-74b4170ae57b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d78694f6-c839-4e29-a84c-2236a1a16e11", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf5d14eb-11cf-43b1-b94b-dbeb20e47d26", "name": "List Company Custom Field Groups", "request": { "name": "List Company Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Company record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4b56eec9-d381-4fdf-b15f-b1b5a24e108c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2481b1d9-289b-4904-83ac-af512bd0e474", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a0b0958-3eb9-4e00-85c5-112e4c19c3e6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ecfb503-4d63-479c-a833-67b0212754b2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37c06eb5-1174-4cd7-bedc-2a9a736a6022", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfdad34a-294a-47b1-9ce3-f4293bf5ee9d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db790eb6-46d4-4f8a-8d12-71d57678d9c3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03e8fe98-024c-43ae-8c1f-a11328a9e6fe", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7126d85-0128-4cf5-9f16-b2fd124028cf", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3444af1f-651a-4317-b731-0ad739f7c386", "name": "Create a Company Custom Field Group", "request": { "name": "Create a Company Custom Field Group", "description": { "content": "Creates a new custom field group for the Company record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4badf623-e29e-4618-9619-5a4ca68f2525", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efd1d09c-6ae7-45e1-acb0-943c5f7c7e38", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "979af572-f6ae-4bbc-8d4e-5cf6e19f1e79", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad71841-f286-4be3-949f-c05b5a05a925", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41bbfc6b-5424-4414-b206-1d9485dbe8e2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee657a6-a04e-4790-a505-0e040c4978a3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76f3b45d-8ca4-47c1-a0ac-2a78e602948f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2de3841-351f-4ce4-b9da-a347a19cc666", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e2f12b8-12e8-4f5d-b4e8-4f0f8387786e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6aa2dcf-20e5-4744-b194-676e238fe379", "name": "Retrieve a Company", "request": { "name": "Retrieve a Company", "description": { "content": "Retrieves a single Company", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Company properties to include in the response. (Available fields are: `address`, `custom_fields`, `email_address`, `fax_number`, `phone_number`, `website`, `notes`)" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e042438a-4996-4f86-9682-0cf2564719ad", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"groups\": \"1,5,12\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\",\n \"account_id\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d40a2f-a1b1-4092-a8ed-7e84e17d06ad", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a071ec-ee2c-4773-9add-0bcfb93b5b45", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b279ac09-e8b1-40c3-8bde-ecc39d78605a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83dcf769-9efb-41ae-a044-4a561a848bca", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f9278e9-0405-4cb2-b4ef-7d76a4989a8e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "589b97a7-074a-447c-9984-41aed05cff31", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b53ebe90-e36f-443d-a374-994aab8f5a8d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b7028e-4c19-4525-9caf-d0fb2eb8f13a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83dbe390-2aa8-486b-b596-8a12088d5433", "name": "Delete a Company", "request": { "name": "Delete a Company", "description": { "content": "Deletes the specified Company", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2ed2a5bb-cf00-4a9f-8a91-2eb4248d46cb", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83f1c73a-c6b3-4ac1-89d1-af2ddc868315", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f3fd56-6e9a-4e5e-bfe5-baa3ae4b48b1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3e58299-3d49-440f-a9f2-4409a200866e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e59d98e-79b8-46ae-916d-890b42d1ef38", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "200c6cea-30ff-40fb-a534-534d6a60bba4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659d8010-cbe3-402c-a1de-17b62e47929f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883f020b-5a32-447b-b8e6-972818666176", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c03a008a-783e-4db1-b930-b1f5c553eba3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd453e8b-5bda-4288-bfb5-6607db5cccfd", "name": "Update a Company", "request": { "name": "Update a Company", "description": { "content": "Updates a Company with the values provided in the request", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "owner_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "anniversary_date", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "727f3172-9f4d-41e3-8bc4-50b913107aac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"groups\": \"1,5,12\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\",\n \"account_id\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e730a1-9723-4614-aa11-53f91a5e58b5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f570bd-2e77-4ea6-8d8b-541deb150c29", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19705dd4-1ea2-48b0-b6b9-004b93a395de", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9849115d-c336-48d8-bd1b-69759ca31566", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eaa207b-b287-4172-a9d4-713864c1651a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5937a20c-a362-49c1-a44e-0fcdecb95825", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e823738-c31d-46ef-a86b-05a1319d53f0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48e6ec7f-ea87-45b9-bd9e-7202cc027b81", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "create_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Key enterprise client since 2020\",\n \"website\": \"https://www.thryv.com\",\n \"suffix\": \"Jr\",\n \"title\": \"Dr.\",\n \"company_name\": \"Thryv\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n },\n \"is_opt_in\": {\n \"value\": \"\"\n },\n \"email_opt_status\": {\n \"value\": \"\"\n }\n },\n \"fax_number\": {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n }\n },\n \"phone_number\": {\n \"extension\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"number_e164\": {\n \"value\": \"\"\n }\n },\n \"anniversary_date\": \"2015-06-20\",\n \"assistant_name\": \"Jane Doe\",\n \"assistant_phone\": \"555-123-4567\",\n \"billing_information\": \"NET 30\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Vendor\",\n \"first_name\": \"John\",\n \"job_title\": \"CEO\",\n \"last_name\": \"Smith\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"owner_id\": \"string\",\n \"referral_code\": \"REF2024ABC\",\n \"spouse_name\": \"Jane Smith\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "809796cb-1450-4803-938f-ca7adbf7b46f", "name": "Delete a Company Custom Field", "request": { "name": "Delete a Company Custom Field", "description": { "content": "Deletes a custom field from the company model", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9afd44b3-cb66-48e6-9f46-cc486467f2dd", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06ab35dc-392e-4243-9994-fdcc32cd1803", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c0301f-f76a-454c-945a-2a6de4f339e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393eef78-1058-45ae-a393-5db3d6e61ad3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90386c25-7c46-4537-b1a4-d8dbfa62c7d8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0ec2bb7-dbc0-413b-aebe-6bdf4cb9b38f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3de13e91-eec7-4c96-859d-4bb1caad0f4d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21c9ab13-bc94-48c0-a7f2-ecd33cc0663e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72822487-1054-43c9-9454-782c0680a4fa", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fc3586f-1cce-4bc2-b3a9-1176ad3ebbe6", "name": "Update a Company Custom Field", "request": { "name": "Update a Company Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Company object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3dd06442-f270-4ba7-ba1c-2f5e3d3b2341", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8e9bc8a-214d-4500-b82f-a4ad69f50b61", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73874a9a-8410-419e-a53e-fead94b019da", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76cf779-6836-4a2f-9046-980717b6b8ea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90e7e44-92a8-4172-ad0d-eec938fcfe4d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee9ca375-c6ca-4d65-9b7a-23fbd1d0e512", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34a866a9-390a-459e-ab7c-a49c62a5f52b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cee4729-f7a8-407c-9da6-ef60298e2c8c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bff2760-e91e-45c3-8eb1-3ee58f506397", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1773101f-a922-442f-819f-48af4d103d01", "name": "Retrieve a Company Custom Field Tab", "request": { "name": "Retrieve a Company Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Company record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e9e28136-d964-422c-93de-ae001ddc0d6f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd5d4305-b579-456e-adbc-3d1105db1df8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f379ee1-c831-4f04-989e-c455007e30d7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e56878a-3fbb-4238-b141-91645a78446d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db180c3-eb47-4a51-96b7-7accf8e240dc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e1b0ee-f57e-4585-84f5-4f3d9e31c025", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d6fbe8-9a93-4082-8e08-316329e000a5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b2bcb6-ea58-4b59-8aac-2e361e8096e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e773c27f-7c97-49a8-8043-81e918fa0a0f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "414b2385-3132-44cb-8c37-41cf5e95d914", "name": "Delete a Company Custom Field Tab", "request": { "name": "Delete a Company Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "5b1c0c34-0ae8-4e6e-ac29-c7a5b61dfa5b", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f9533db-12d5-42f8-9219-f7eff9a5ea79", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e6e41a-9ca5-4992-b908-2b8272b33986", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b628969f-f8e9-4f4c-b24a-9ab2b625ffe4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f5d9bb3-cf81-4942-b3c9-f3dc0afdbf14", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6df5dac-7430-4081-a0d6-75b24981eaa8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2f2aa5c-b8ff-4917-a961-1d41cde540f6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a04fc96-0195-4c1b-83b1-727af2cfef4b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed0d99d5-a514-4a91-ab99-2324fd5a5b9f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e42f4cd-4e38-444a-b1af-a8bb2f8848f1", "name": "Update a Company Custom Field Tab", "request": { "name": "Update a Company Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "374850d6-66ef-4dc8-96e3-f530ff5bd86f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2926fa9-cad9-4c43-a660-f4780ca1dd3d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8366d1af-f253-454c-a455-1d22ce7c714c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53076b2-660e-45f5-b246-19d001db379e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "769eac3e-0a74-4eb6-81c1-7d785b6c47eb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28fc9ac3-2e87-45e8-a4ba-b00ca7e0567d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fcbc9cb-e01e-409f-b985-6272547644a1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0c0ecbc-5610-4f72-bd28-641c9e3f5cf3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a1fcbb-c58e-42d8-9ce0-b91818d0482e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b27e9816-698a-4e8f-a1a0-e0044c98d237", "name": "Retrieve a Company Custom Field Group", "request": { "name": "Retrieve a Company Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Company record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "75a37105-0571-4b3b-9356-782de6ef89bc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f74897f9-80ae-472f-a0d2-3ae86a38ea74", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f05e154-817d-44cf-9762-3a31adf60d15", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea660f4-7e2e-4cfc-ab81-5f25cb343a1d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abda48cc-67d1-408b-9d22-e5dc51385b0e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d88575-3457-4df2-adaf-d53c9c6817cd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb4a18d7-f02d-4346-b668-9bd2a09ea63c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c38d03-cdda-438e-8779-1a4e1226ebdd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59961668-9508-486a-8c90-500c503534c8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1521a866-c532-4c58-b577-fdbb5a314c3d", "name": "Delete a Company Custom Field Group", "request": { "name": "Delete a Company Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4fe4c031-ddbb-45d0-bebe-c8ba7a8fd4cd", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1fc1ec5b-e21e-4e00-a0df-07cfce0f42d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a40df7-b23d-498d-8765-1330180f0056", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05283b35-270a-4965-a496-9ae49539eef4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d39f3c-b033-4270-b3f8-17c4e9502fbe", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba782e7-f727-46f9-b260-3ecbc1c07d85", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "570cb023-1cfe-4489-914d-f4f4fcf0ad97", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717475d0-8cdf-478a-8ead-cb86c09e0128", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d3f1628-e66f-4607-8a87-a4fb20345919", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "239ff2b1-2e5f-4e7f-9cd3-43b0d995451d", "name": "Update a Company Custom Field Group", "request": { "name": "Update a Company Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "42c4ec27-2e53-4a25-9901-b559a198923f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0ec46ee-41a9-4a5c-8230-77c1b8929503", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f86d880-85db-4d9f-9b78-e75153580eee", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b83c327-288c-4b75-9fa0-fc91ea4ecc64", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0228c9-249b-4974-90f4-aed05b712df6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7bca1c3-0dac-430c-a767-59a0402ab029", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e1c146-2458-4a18-8706-dd15145b2bfc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0516c14c-afd9-48ac-a55e-95a75556d2b5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ac4826a-71ad-4eb5-a087-61ff8f30d52f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94c94298-89d9-419b-b9e8-5cd60884ad7f", "name": "List Tags For Company", "request": { "name": "List Tags For Company", "description": { "content": "Retrieves a list of tags applied to the specified Company", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `description`\n- (String) `category_id` (use `category_id==NONE` to filter tags not assigned to any category)\n- (String) `since_applied_time`\n- (String) `until_applied_time`\n- (String) `since_create_time`\n- (String) `until_create_time`\n- (String) `since_update_time`\n- (String) `until_update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=name%3D%3DCustomer`\n- `filter=category_id%3D%3D123`\n- `filter=category_id%3D%3DNONE`\n- `filter=since_applied_time%3D%3D2025-04-16T20:33:02.321Z;until_applied_time%3D%3D2025-08-16T20:33:02.321Z;`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `create_time`\n- `update_time`\n- `applied_time`\n- `category_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fc9ca70e-a5b1-4cce-8eab-11f99b7d4a91", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1846143f-2e98-497c-b684-eba2d9c7d4fe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6adfa037-7ac0-44ad-8d7b-ebfff4ca7d3c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a59d6562-2cda-44ef-a372-8d225c3779ac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4afa36b1-9009-4732-b306-12abd78eee4f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47f9033-4e24-4c16-899e-8622547e0a3a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f175bb-7810-4453-b966-c54f82d25175", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88021877-d936-4918-af5d-8cf437e3d5b0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fb978b9-6c32-44cb-aa0c-dfd5594144d6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "company_id", "description": "(Required) Company identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87c2a6a5-3d4d-4864-9002-3ef5eb29c603", "name": "Retrieve Company Custom Field Model", "request": { "name": "Retrieve Company Custom Field Model", "description": { "content": "Get the custom fields for the Company object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "278e63e8-8c9c-4bfc-82d2-e804f33c6ff1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e38b3d8d-90ed-49ba-a3ec-8938f45871e4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fce5416-10e9-49e4-8ecb-381ff5d406f8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46c74d5b-07f7-42c4-a6c4-65eec7c56a47", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9285aed7-f61d-453c-8ed7-585be79d9c55", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8defd42c-b77c-4891-b91a-d7857be21006", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "574090cb-87c6-4baf-a8d0-5b082336e79f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ffe3288-9c7e-4b53-a559-154a0d85ee16", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b57b8e33-362a-4224-a683-47f51f5a5c3e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5ba3df0b-6d1b-4039-86ea-a829af414d33", "name": "Contact", "description": { "content": "Contact endpoints.", "type": "text/plain" }, "item": [ { "id": "77f7f44b-70b1-4732-aba1-b5d0149f2086", "name": "List Contacts", "request": { "name": "List Contacts", "description": { "content": "Retrieves a list of Contacts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `email` — supports wildcard (e.g. `email==john*`)\n- (String) `given_name` — supports wildcard (e.g. `given_name==Mar*`)\n- (String) `family_name` — supports wildcard (e.g. `family_name==Smi*`)\n- (String) `middle_name` — supports wildcard (e.g. `middle_name==J*`)\n- (String) `company_id`\n- (Set[String]) `contact_ids`\n- (Set[String]) `ids` — accepts a list of contact IDs (e.g. `ids==1,2,3`)\n- (String) `start_update_time`\n- (String) `end_update_time`\n- (String) `phone_number` — the phone number to search for; supports prefix wildcard (e.g. `phone_number==555*`, \"starts with\"). Wildcard prefix must be at least 3 characters (e.g. `phone_number==55*` is rejected). Requires `phone_fields` to be specified; only the specified phone fields are searched.\n- (Set[String]) `phone_fields` — restricts which phone fields to search (e.g. PHONE1, PHONE2, or comma-separated list PHONE1,PHONE2,PHONE3,PHONE4,PHONE5). Required when `phone_number` is supplied.\n- (String) `billing_address_line1`\n- (String) `billing_address_locality`\n- (String) `billing_address_region` (long-form region/state name, e.g. \"Arizona\")\n- (String) `billing_address_postal_code`\n- (String) `billing_address_country_code` (ISO 3166-1 alpha-3, e.g. \"USA\")\n- (String) `shipping_address_line1`\n- (String) `shipping_address_locality`\n- (String) `shipping_address_region`\n- (String) `shipping_address_postal_code`\n- (String) `shipping_address_country_code`\n- (String) `other_address_line1`\n- (String) `other_address_locality`\n- (String) `other_address_region`\n- (String) `other_address_postal_code`\n- (String) `other_address_country_code`\n- (String) `city` — primary-address city (Contact.City); supports prefix wildcard (e.g. `city==Chan*`, \"starts with\")\n- (String) `state` — primary-address state/region (Contact.State); supports prefix wildcard (e.g. `state==Ar*`, \"starts with\")\n- (String) `website` — supports wildcard (e.g. `website==https://example*`)\n- (String) `lead_source_name` — supports wildcard (e.g. `lead_source_name==Google*`)\n- (String) `contact_id` — supports comparison operators: `==`, `>`, `<`, `>=`, `<=`\n(e.g. `contact_id>5` encoded as `contact_id%3E5`)\nCustom fields can be filtered by their field_name (case-insensitive, as returned\nby GET /v2/contacts/model). A standard field above takes precedence over a custom\nfield with the same name. The supported operators depend on the custom field's type:\n- Text-like fields (text, text area, name, email, phone, website, social security\n number) and single-value choice fields with text options (dropdown, radio,\n state): `==` only, with optional trailing wildcard (e.g. `firstName1%3D%3DValue%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (whole number, decimal, currency, percent, year, month, day of\n week, user): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=`; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `2026-01-01T00:00:00.000Z`), the same format as `start_update_time`/`end_update_time`. Date-only values such as `2026-01-01` are rejected\n- Multi-select fields: `==` matches records that contain the given option\nCustom field filtering on non-indexed fields is supported but may be slower.\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\nFor wildcard filtering, use `*` at the end of the value (prefix matching), encoded as `%2A`.\nFor the filters listed above, here are some examples:\n- `filter=given_name%3D%3DMary`\n- `filter=given_name%3D%3DMar%2A` (wildcard: starts with \"Mar\")\n- `filter=company_id%3D%3D123`\n- `filter=company_id%3D%3D123%3Bfamily_name%3D%3DSmith`\n- `filter=billing_address_locality%3D%3DChandler`\n- `filter=city%3D%3DChandler` (city exact match)\n- `filter=city%3D%3DChan%2A` (city prefix wildcard: starts with \"Chan\")\n- `filter=city%3D%3DChandler%3Bstate%3D%3DArizona` (combined city + state filter)\n- `filter=shipping_address_country_code%3D%3DUSA%3Bshipping_address_region%3D%3DArizona`\n- `filter=contact_id%3E5` (contact_id > 5)\n- `filter=ids%3D%3D1,2,3` (contacts with IDs 1, 2, or 3)\n\nCustom field examples (for custom fields with field_name `firstName1` and `Score0`):\n- `filter=firstName1%3D%3DJohn` (custom field exact match)\n- `filter=firstName1%3D%3DJo%2A` (custom field prefix wildcard)\n- `filter=Score0%3E100` (custom field numeric comparison)\n- `filter=given_name%3D%3DJohn%3BStatus0%3D%3DActive` (combined standard + custom field filter)\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `create_time`\n- `email`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "10c4517b-5ec7-4509-8fe5-e8bd0380f3a3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44bfda07-cc6c-4374-9c16-0ba0807157e6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58fe46e3-bc6e-4486-b081-b1f19a96e00c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2425c83e-c592-42c6-ad67-91ddf1b358c7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8df48d32-f469-4089-a66c-b1c8c8f1a597", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32e3bfd9-d6eb-4a75-bedf-912bd60273b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac4f4c0a-90af-42ec-84cf-346fcb3f292f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4985c3d-0491-434f-bd87-66e8b298ac39", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a007b825-48d7-4728-bf7c-5a6c342605a4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c8a7223-d30d-42d8-b72d-f0b11cccf9f4", "name": "Create a Contact", "request": { "name": "Create a Contact", "description": { "content": "Creates a new Contact.\n*Note:* Contact must contain at least one item in `email_addresses`, `phone_numbers`, or `addresses` and `country_code` is required if `region` is specified.\nOptionally accepts a `duplicate_option` query parameter which performs duplicate checking by one of the following options: `Email`, `EmailAndName`, `EmailAndNameAndCompany`. If a match is found using the option provided, the existing contact will be updated. If an existing contact was not found using the `duplicate_option` provided, a new contact record will be created. When `duplicate_option` is not specified, a new contact is always created.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "duplicate_option", "value": "EmailAndName", "description": "Duplicate check strategy. If provided, performs duplicate checking and updates the existing contact if a match is found." }, { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"API\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e54405d-3677-4800-b247-359c80215c9f", "name": "OK - existing contact updated", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe2dad30-8360-49e6-8689-79c8cd0e8bfd", "name": "Created - new contact created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1154073-931a-4aea-9198-d8f054519b69", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a72f47-f371-4212-a2f4-6b71169a138d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a95bed9-0f83-43ec-af12-7c578c4de08f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5ca908f-9cb0-4c17-8db3-b0b76dc3ecf5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c9f73a6-b51a-4af3-9fd4-a79a7503ec7c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd27c66-9076-41be-afa3-db4695687eeb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f43e47-ffbb-4c62-9018-f66efc288e7c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b447b0da-9fd8-4544-a394-5f220d86f020", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndName" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2330cffb-745c-448c-b17c-2574aad190ac", "name": "Delete Link between two Contacts", "request": { "name": "Delete Link between two Contacts", "description": { "content": "Deletes Link between two Contacts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0170eb6-2cfb-435e-8790-1a4cd9831156", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38d5260f-0a88-48d2-9ae7-a98e00fec2d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88b6b1ef-528b-4279-8ece-2e59311e6ea5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0890e16-6654-4ef8-a3da-e865cf30291d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec83edb7-816c-46fa-904f-8ef0d46bd159", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f02fd75-cc36-4283-bf7c-a5ab3cd2e83e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "380240ac-e4e3-42b3-ba69-e412885a5bd9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ad9a87-05f3-4780-a2e8-98ac4e22ba61", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "498a3d54-43e0-41c4-8d7c-742db1d2ca7f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:unlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44268ad8-286c-4667-85d9-7c0fdbc065df", "name": "Merge two Contacts", "request": { "name": "Merge two Contacts", "description": { "content": "Merges two Contacts together. The duplicate contact will be merged into the primary contact.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75a0c80b-9e7d-4b0c-b0ce-64b7191583aa", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "309498b2-9a74-4ce9-85e1-8cebb7ed2bef", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f48b0277-d91f-4f90-a104-f8ef21dd9f34", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e284267d-dcb8-4bdf-9606-a3924c579961", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "126cd045-0b2a-4134-9c40-3720b6cf934f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "714b9fef-7deb-49d3-94c8-dca35e62f8f0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61345ac0-866d-4315-962b-e54c66b2dc27", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d99ce8c-8a1d-4703-b361-e5749439b118", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe93c100-7543-48b7-a52d-445b884100bd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:merge" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"duplicate_contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d82b849-4dcb-4722-a536-563b79f06c62", "name": "Link Contacts", "request": { "name": "Link Contacts", "description": { "content": "Links two Contacts together using the provided Link type", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "51123124-7675-4d57-bcf1-aefc54c2159d", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact1_id\": \"string\",\n \"contact2_id\": \"string\",\n \"link_type_id\": \"string\",\n \"link_type_name\": \"Spouse\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71086344-fb21-4a00-b387-473a80922666", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79aaf6fb-8000-481a-b110-417693159e45", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f031e0dc-de1b-4c73-8c84-30f29b3b2548", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "025d7792-907e-47be-846c-2b80f2b2f0c2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e09504-a32b-4682-80fa-4cddf047b562", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be7ddfad-4d1f-434e-8e60-befe5314de2c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3220b526-67ef-44cd-8a29-d2f6109d29a2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3beb77-31c3-4e91-9e19-4994fefef481", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts:link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact1_id\": \"string\",\n \"link_type_id\": \"string\",\n \"contact2_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c85cf49-b5ad-4c97-aee4-9c7bc531c3ea", "name": "Create a Contact Custom Field", "request": { "name": "Create a Contact Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Contact object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "385d98e3-c736-4522-976f-d5fab8f823a9", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8370ed09-19d2-4754-90bc-2d0c4f86ed94", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48946efe-0174-449e-86da-d073399401e9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9362f5b3-7485-4e40-a005-cc03ed318f4a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "075f7d2f-820c-463c-9d8f-5d23e65c15b9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d29d72-fdd9-40cc-a4b5-da327b3d3998", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd660b30-72b0-4111-9735-9d42fcbef841", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d03ee44-95c2-4ca8-b3db-25a84b6ad9ac", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be10b990-a926-439a-8e1b-6eeeac956935", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51488bd3-8dd7-4b7c-a54e-42ff88946300", "name": "List Contact Custom Field Tabs", "request": { "name": "List Contact Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Contact record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "abd2e05e-bfc7-49ee-9c3b-a6050f53f0b9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443f27e9-22c9-4fc6-96b3-2a5791dcda64", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0228cc7-4637-46d0-90ff-78af84c70418", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ff7715-13d3-4347-a1f9-93cc3f545f7f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4b6ba6-6829-4e97-a85c-4fa8c8fdce2b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79a1cd5b-b2e9-4d1b-9019-e52baf338b28", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0578de9d-e88c-443b-bc04-40cca9d09863", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60ff1623-d6eb-4bd2-813a-f8b4ab2f7b9c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae24269d-b255-49e8-bdd0-9ad108e7b28f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47952572-e342-412c-9220-137c84719e65", "name": "Create a Contact Custom Field Tab", "request": { "name": "Create a Contact Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Contact record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "00b8f2a4-2a90-4276-801c-861f80fdbc1b", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "710a947c-c17c-4b6f-be08-eedc17a3c261", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7578cac-f739-435f-a9ae-cdf1bfe4e5f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a536a72-bade-4133-86c4-a93555f1c759", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d779d866-ea06-4bb5-932c-6543b242f588", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9afe0951-508e-46b2-8e5f-09b255d76e05", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "560b46ab-5ecc-4758-a990-b5af0292f7ae", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15545eef-3301-42a7-8c26-a14b9ac1ac61", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc12afa2-49e8-4c91-8bb2-771ad6515ec5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad4be5e0-2e59-4ce2-9ed1-04c6603a9d38", "name": "List Contact Custom Field Groups", "request": { "name": "List Contact Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Contact record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "938c669f-ff09-4c1d-bb4c-b4d9122336d2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecc53b49-749d-48aa-9827-5e9395f12587", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e7f45a8-e188-4d06-aae0-80b3fc2ab8f7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ba69ed-a6eb-402f-af19-72cdbce2bc52", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dc874f5-0cae-4d70-b3dd-c38af2065516", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e79e01b1-ba8e-4cae-8494-86ad6721d307", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77df6e0-ab4c-4c01-81c8-ab1bad802261", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1745d1-7a21-4c69-a82a-1381523c6903", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fe92666-89d1-47f7-a3aa-26e247e19566", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "343580a6-5943-4712-b5e0-b4a59f8e5da8", "name": "Create a Contact Custom Field Group", "request": { "name": "Create a Contact Custom Field Group", "description": { "content": "Creates a new custom field group for the Contact record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9afcf6f1-4de7-4f3f-9244-a001f8383dfc", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f64962c-61f4-48a2-b1b5-c42200912225", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca05166c-140b-4492-a264-a2f1803b99e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afa667f4-4867-4db4-91a1-6ed339aaca04", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07815ce-e7b9-45ae-ad60-af2ab5ef3531", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e256719c-33e7-4d45-a884-d95ace328fec", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59e132bd-d330-40d8-9d7b-9b28d114a266", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2f1801a-b81b-421c-8611-ba204b92f1f6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18c02500-443c-4a2f-9b10-3de29d4b669b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d29c96c3-83a1-4eaa-871c-30cf102c3f82", "name": "List Contact Link types", "request": { "name": "List Contact Link types", "description": { "content": "Retrieves a list of Contact Link types.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=name%3D%3DexpectedValue`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `max_links`\n- `create_time`\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5c75535c-fa0c-42c4-9e14-1f9015f66229", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact_link_types\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a133c1-b439-4ddb-8a7a-37f7aa254403", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "490630b7-cacb-4109-b42a-a8c84f778f49", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf999ec0-6ad5-4105-8dd5-3cd54076c69b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc4fc9f-d60a-43f3-8879-f200d02e3db0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfa1400d-dc86-40ea-ab78-5e59bed28df1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153d94ef-1d34-46ea-a19a-1bceaa3bdcdc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc8eaca4-a1e0-4d41-ace0-c152eb1027d8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce206753-6391-480c-871b-db9f07242e6b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4812386-eb5b-4b02-82aa-9608f15cf09f", "name": "Create a Contact Link type", "request": { "name": "Create a Contact Link type", "description": { "content": "Creates a new type of Contact Link", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30507763-601d-4c46-8a56-7fd5bc17a03a", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Spouse\",\n \"max_links\": 1,\n \"create_time\": \"2024-01-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23e10f7f-a32d-4665-a3eb-95428f97ff88", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a4d1e1-cda9-428b-871f-18f96385d49b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6486887-f3a6-463a-85be-9cc1917b6601", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9bde610-7dfd-4575-83be-30f2135b113d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0199ab7e-50ae-44e6-8db4-9a8f549f14d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3970fe3-362d-40ae-a5c0-12c8680a53e5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4036040f-e928-495e-8ca0-e13a9fb3d457", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0d8cfd-79e8-493d-8442-20390fe1d0a0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57639cdb-b004-424b-8dc6-b42a45e681f0", "name": "Retrieve a Contact", "request": { "name": "Retrieve a Contact", "description": { "content": "Retrieves a single Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "708b881e-82bd-49ab-933d-a6eca2ef3c14", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffffcf25-33fe-4276-9560-9b3b126bc976", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "922e31ce-eb2d-4dcb-a3e8-efc579556433", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "370bdd5e-a093-4ee8-ae50-d6d4f5339648", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f009ef9-a872-48a0-81ba-308bb4f6d424", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd68345-7d8d-4ebb-b2e5-758ea0b80d9a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac84d04a-3e24-488f-b806-6d582ffce4d4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2150cc39-d861-42e9-a593-53539954ca10", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76855d18-b789-41fc-b910-3369bc38464e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f65094f0-8cce-48b8-8c5a-a9dbfd83def6", "name": "Delete a Contact", "request": { "name": "Delete a Contact", "description": { "content": "Deletes the specified Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "467a5cab-5dcf-457b-8c03-81eaab547992", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dfef4fca-4331-4e76-850d-7795b58906f6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f47de124-6164-4175-b0b0-cf58ae93e433", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1b77996-3aa8-4ed7-8b57-004c0c7c11e5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa65293d-1731-4330-91aa-ea863f4c0d0e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8673e538-9830-4e91-a9f4-5b212dbd4d80", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ce04a6-4ee9-4439-9aa7-0fbd82f9fecf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b579fccf-86ee-45b9-9f97-7810134ee9f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "999ebce5-a855-44e9-9b18-7cb00e4e79dd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a6a8156-2234-4640-9f47-91a7c84a5b39", "name": "Update a Contact", "request": { "name": "Update a Contact", "description": { "content": "Updates a Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "assistant_phone", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "family_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"API\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3074c62-b39c-46c1-89fb-94729c67261d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": \"string\",\n \"assistant_name\": \"string\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\",\n \"created_by\": \"string\",\n \"last_updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e8a3d1d-ecc2-459a-9430-fbc94b3ffc7c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3185267b-ec23-4402-8b0c-953b73a07816", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bbb0607-f782-48c0-af4b-9df4e8892b80", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833dedcc-e0e8-423b-b1a9-de7328d16350", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135018c0-57e3-4b3c-aa4b-692742bb5467", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c22b381-b5a3-4d25-9b08-97a7da675438", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b247bf5f-a7f6-4a8b-905c-22798344d924", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b52e742-d2d9-4ff7-b9f1-79beb3ba8992", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "preferred_locale" }, { "key": "update_mask", "value": "birth_date" }, { "key": "fields", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3121fd40-0b6a-4fc4-876d-6c7e3486a11b", "name": "Retrieve a Contact Custom Field Tab", "request": { "name": "Retrieve a Contact Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Contact record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8c466115-ccc4-473d-8a99-d159dae5d312", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6c95c55-2b32-4d03-8d6c-bf36e3e4a977", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be277f0b-6cb1-4a98-8940-c07f97ed0a76", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b4ee6f-1811-48f0-b49f-cb933552035b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a822fef-5293-4036-82f3-9ee85b11b897", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc1cb5b-1c16-48d7-8bb7-137e82993688", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a5ccb4f-626d-4b3b-b0bc-f835c21ad4b4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564963db-66b9-4965-a2cc-8584ee3522d0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5c2f50-3eba-48bc-8cae-e078b569c378", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7125a121-26e5-4956-8968-3c7e216cbb69", "name": "Delete a Contact Custom Field Tab", "request": { "name": "Delete a Contact Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "173d2921-8a2a-4e90-a19a-ef23df6f5676", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de33c51b-b7ab-4489-b6a6-3d51fa636777", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3431a6e3-1414-4c40-82a9-eb7ea94a7101", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d178070d-43de-41ee-ab1f-68410c7f3528", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79656c5a-bf7d-4406-8843-5c61beb7ad71", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14dc3742-fc38-4598-8b8a-37d6bd884987", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5cf3cb-19eb-45f8-abd0-d451aa3f10ef", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03481780-87e9-49fa-ad40-1c183eb41f83", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc4aee8-ea8f-4725-aca9-074ee1ad078c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00784dd8-7dc4-422c-bb14-f9338d92ac1b", "name": "Update a Contact Custom Field Tab", "request": { "name": "Update a Contact Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fb753b45-b869-4577-a77a-a8f441f42514", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b553a5b-946f-4500-839a-cc5a8dc642da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60b17b5-42b7-4ec2-bf93-79b01bef5613", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5237890d-0e8d-4408-968d-b6f61a40ac81", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01e4783b-c6ce-4d02-ac8e-f751638634e1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b43d54f8-8568-4060-b376-974388686296", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be1ad41-ad21-40db-bd2a-770ada1df56a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "476a7f08-b551-4296-a545-544c3e7ed42b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91afe7c0-cdf6-4d9a-9692-16bf28317bda", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "079c1f98-91bd-4b6c-8a51-79fff422d21c", "name": "Retrieve a Contact Custom Field Group", "request": { "name": "Retrieve a Contact Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Contact record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "dec43ebc-1e71-4b62-b942-039c852da495", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4217709d-9c20-4925-a425-9f9215066267", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e46da84-c81c-495e-a053-2edf3f2fd33f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf18946-bb35-4893-84f7-885feb8d2658", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50b0f1ee-c2cf-4822-99eb-a2258a4e2e22", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bad7213-6aa1-4f7d-8371-fe3bf7e8dc89", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d466ebd2-e0ce-4d16-b7da-b97406ee250d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46c1b2a6-c55d-4e16-a961-09921d6e168b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b935c0c7-39cb-4f6c-bf49-61120e5279c6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03eccf5f-aa67-4556-8b9d-bb6a10e70826", "name": "Delete a Contact Custom Field Group", "request": { "name": "Delete a Contact Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "6dc5f06b-7e70-42e8-a7b8-e475f6ba1460", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9fbaf46-dfca-49ec-8a1d-67908a887d41", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06cbd272-bcdd-455c-835f-8c43c2d68376", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62d8c2b-9339-4cea-9874-1d812b02946f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7bf44b-f8f2-40f5-8bee-0d49f8286220", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67956711-c86f-4167-af0b-ee05511c6634", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d75fee23-826f-434f-9d66-9fabc0c02a80", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01201115-6e84-4e6e-8d5c-c6d11d402c75", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "963a110e-f1b7-4dc2-9de6-6752ee02253d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f6ca2a7-c30c-4f2d-90c6-2c0da034c1f2", "name": "Update a Contact Custom Field Group", "request": { "name": "Update a Contact Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f3da2858-ff1f-420d-8595-b7668839b3c9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "806d0f1d-7c02-4204-aabb-f47ac21d4a07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d147ea6-20d3-4679-969e-4b78e2bc53e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3dbdf2-4d4f-4a3e-8599-965a704b2eac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24b9e40-2ded-4093-8908-39bc7e2ba755", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb9d2c1-5aa6-42bb-ad34-31161d322a82", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48bd3125-4b8e-4fad-95dc-dac2e0bc0ddc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "355187f8-9af6-46ba-bcba-48271c74c2ca", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13c6e928-22f4-4a8b-a891-2d429713f122", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3561fe46-b01d-4e2e-add6-4b2165c4c23b", "name": "Delete a Contact Link type", "request": { "name": "Delete a Contact Link type", "description": { "content": "Deletes the specified Contact Link type. The Link type cannot be deleted if it is currently applied to any Linked Contacts.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "51e4af34-8067-46d1-ae11-f05e465ad47d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bab63b83-ea19-4382-b7b1-7b248eab0b6e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fa21989-0880-4891-844b-dca3c9e049d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31eee068-f0d3-42d7-89ee-e31432ff3e73", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e2c2aed-a8a1-4b86-be31-36298169c9ae", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b4ec982-822a-46dd-8b86-932fe72b16aa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddebab88-ad61-42f0-b863-af8db7da57d9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19402ce-a022-4e07-b184-2b2f0c2859f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b789d231-4854-4d01-8983-fe2cf9e1d63e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81eaaa5f-c12e-4ba5-ae95-4d771773d6ae", "name": "Update a Contact Link type", "request": { "name": "Update a Contact Link type", "description": { "content": "Updates the specified Contact Link type. Only fields listed in `update_mask` are applied. Reducing `max_links` below the current number of Linked Contacts of this type returns 409 Conflict.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "max_links", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "02b647e2-d864-4c2f-91b3-e776eb3643cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Spouse\",\n \"max_links\": 1,\n \"create_time\": \"2024-01-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e6bb82c-ad77-4ca3-802b-ca5102b179ba", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b323bc50-fe19-4135-8504-ddd073d143e2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee6903c1-25fc-4fa3-b87e-3e789091a7cd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb9ad41-e8bc-4c85-9dab-622ecced709f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be272ed-6b33-423f-bdce-a480bef7c6fe", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd9f733-bed8-47f6-ad3b-7bbfc6b186b2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f928b24e-3362-41b0-9438-bc304fa233a1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1cb61fc-de74-4346-b20b-8aa23fa2e010", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ad7ac44-4b1d-4823-a88f-e0fc4eefbfd2", "name": "List Tags For Contact", "request": { "name": "List Tags For Contact", "description": { "content": "Retrieves a list of tags applied to the specified Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `description`\n- (String) `category_id` (use `category_id==NONE` to filter tags not assigned to any category)\n- (String) `since_applied_time`\n- (String) `until_applied_time`\n- (String) `since_create_time`\n- (String) `until_create_time`\n- (String) `since_update_time`\n- (String) `until_update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=name%3D%3DCustomer`\n- `filter=category_id%3D%3D123`\n- `filter=category_id%3D%3DNONE`\n- `filter=since_applied_time%3D%3D2025-04-16T20:33:02.321Z;until_applied_time%3D%3D2025-08-16T20:33:02.321Z;`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `create_time`\n- `update_time`\n- `applied_time`\n- `category_id`\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b1adea26-feee-4f01-8639-ccd14cc4bddd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a4f0f4-9200-4ac4-912a-329fe9f8ffc2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d50e200e-1543-4ebd-ba6f-1993d051e3c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f13f05-8035-4712-b44d-4bb4a0ba8eaa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c574340f-8dfd-4403-a989-4fb40494e195", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b82bc813-42bf-4a75-8059-64d269c60fa9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b4170d-40cb-4244-8b11-360326db6fca", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba81469a-c6dc-446d-aa7b-99687da94014", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30cb95d8-f38c-4548-a9b4-da16a082f80a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) Contact identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82d4d7ff-4379-4fee-827a-988dfaa76014", "name": "List Linked Contacts", "request": { "name": "List Linked Contacts", "description": { "content": "Retrieves a list of Linked Contacts for a given Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e7738028-27ed-4400-9bf9-d26a63099c2d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58b47c41-4e7f-4df5-8e30-7da93073798d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96f1a3d-bde1-4bb3-9fcd-6ce400a47808", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5837092e-aaca-4c82-857a-fba2a02f3f46", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5732edb9-f1f1-4bc9-8773-2224b40d3fb3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "365fa4d7-4a27-4edb-8566-5d4111c6c230", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6f48bd-335c-4fde-ba04-a09349d28b3b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3108a62c-846f-4989-9647-ad08d5835044", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da3bfc03-e937-4001-8136-538609f19769", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "736ea022-7549-4754-b0eb-7deb8aefed4e", "name": "Retrieve Contact Model", "request": { "name": "Retrieve Contact Model", "description": { "content": "Get the custom fields and optional properties for the Contact object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b34981af-6d81-455b-82e7-a43ad30f99d6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2822dbfd-b4d5-407e-bb23-3c0d44ed31f2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c479cd14-8a79-4848-a1d4-6652ca82de04", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "783dee26-4dab-4e06-8bd9-8a08f8c0d667", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd253c8c-82f5-4747-9f60-78c2edbbf415", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766c7219-effb-44be-9ff4-523043f04ed3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b4f397f-3b1a-4288-be46-d8e9d0abff17", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3be65862-b901-460f-b2bc-ea4f0ecba7eb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1695e422-b3c0-4666-aec4-f9b503afb2b2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc4d1a16-68c0-4b2c-87a8-2c5225920546", "name": "Delete a Contact Custom Field", "request": { "name": "Delete a Contact Custom Field", "description": { "content": "Deletes a custom field from the Contacts model", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "17028dae-0444-4141-a6d9-2028d3009fd6", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "549a842d-b879-41a4-9262-928941e82d7d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f41e70-b9a6-4e45-872c-d550dcecd841", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "905f1bd4-70a3-41c4-8206-d24c70d605ce", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8733fd2-4d88-4ac4-bee6-fb9f8e974ae7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "242c60a5-5694-44f6-a26f-e7bd4d578a2a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "722304fa-2fbe-4b38-9d4d-0cf4accade6e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30fc758-5cac-44bd-b1bd-8539ab1c5839", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c70c61-8a52-401f-be96-e2766ba0223f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "add7b0d6-f801-4315-b14d-22678ad32495", "name": "Email", "description": { "content": "Email endpoints.", "type": "text/plain" }, "item": [ { "id": "83a81c2f-cd16-4ab8-806f-fcc17cc552a0", "name": "List Emails", "request": { "name": "List Emails", "description": { "content": "Retrieves a list of emails that have been sent", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) contact_id\n- (String) email\n- (String) start_created_time\n- (String) end_created_time\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `created_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5d3b252b-672a-4f30-9329-c35bb0688f7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19b3af91-b7a2-4f14-902b-fd0d23d61269", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea36afb-0fcb-4bf2-9822-dcb2d419668d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502474bc-21bb-496b-9602-33edbf8cbccf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "926d986e-ac90-462a-8704-86c732b012be", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9aa8f3-1c75-465e-ba07-50c802caceef", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac0789cd-96ef-4f45-991e-c5213ab07d48", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2988203-0a9f-41ae-88e3-619d3370e2c0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fa84e74-a1fd-4175-b344-2857e91ecdfd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39a470d4-d778-4661-9001-8323455024d2", "name": "Create an Email Record", "request": { "name": "Create an Email Record", "description": { "content": "Creates a Record of an Email sent to a Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2682875b-2de9-4c8a-afd2-3188fad1eeae", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_address\": \"john@example.com\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"original_provider_id\": \"msg_abc123\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"provider_source_id\": \"sync@company.com\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4974bd63-0eaa-42ad-815c-23ee92ad2cf7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2e5348d-c9c7-47c2-b68d-71ba47cdc4b6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a13fcb3a-d113-46e3-b889-7747e0c6366d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf56c818-77ed-4e8d-89c1-0909035f623d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b50faf6-f43d-4afc-83a4-f6d2431fb0ea", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "728c7ab7-0a84-433a-b6e6-0bf8c53af7e2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41bee7b9-e996-4d83-b8f4-7b1d23514167", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad805f8e-4a47-42f2-ae63-3a626b76d417", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sent_to_address\": \"john@example.com\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"original_provider_id\": \"msg_abc123\",\n \"provider_source_id\": \"sync@company.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bd48f7a-e135-4b02-be2b-6dc77a1610a4", "name": "Send an Email", "request": { "name": "Send an Email", "description": { "content": "Sends an Email to a list of Contacts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "493f06d8-c088-4198-b0e5-b36e105e2b00", "name": "Accepted", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff792cbd-fa4e-4a0c-aceb-8896eefd32aa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59bc0985-0cb2-40d6-8d91-da8546b7a271", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "979facb9-ceeb-41c6-8d9f-0e510b3e56bf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e294100-fb0b-4f7d-9571-ad7410fd71a3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4848046c-4098-449a-bc7f-976f0d7a8c78", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0079ca4-a7f7-424f-b075-44e87f5eae61", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aacaf00-8331-4a61-8905-cb5d1da184d7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b3a3836-6dd7-475e-a4c0-0f0f98852d17", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"subject\": \"Welcome to our newsletter\",\n \"attachments\": [\n {\n \"value\": \"\"\n }\n ],\n \"user_id\": \"string\",\n \"from_address\": \"sales@example.com\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgbmV3c2xldHRlcg==\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e35b0e0b-47db-445e-bd1f-6585f489a95a", "name": "Remove a set of Email Records", "request": { "name": "Remove a set of Email Records", "description": { "content": "Removes a set of Email Records", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2b44ba4c-d996-463e-ab42-871bcbfc4ac3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d018cdc-316a-4d2e-86e0-4c01d7c6d871", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f7dd6d-542b-487d-b868-0fa59c455d57", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027c0633-3108-4f8e-980f-c12c1e529398", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ecc9685-8d1f-4b98-86b9-14663ed6ac05", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c28e61-9ee8-46ae-98ae-955cb965e213", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "033a4c4d-bb89-4112-bb07-f59937a6d8b5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c29752c-5f25-4f84-ae63-ec65472aaaab", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd08c6e2-f762-45b3-aff6-cf1fd04353b2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58d12967-15e7-4411-a29a-a8edd37747c8", "name": "Create a set of Email Records", "request": { "name": "Create a set of Email Records", "description": { "content": "Creates a set of Records of Emails sent to Contacts, maximum 1000 per transaction.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d58c1953-86e0-4afa-8012-ec2fab335295", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "054921b1-e2d0-46d1-9e33-c43f5ddb07e3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cded2a8b-719b-4550-b423-f03950bf48ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c202dfd-93f3-4047-bc88-13881f7b5d4d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17b98cd-7a15-4e0e-ae14-615937a80e5e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84cbca70-d4a0-4809-9894-a76e790e0fd2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12957d67-a4a1-4f49-b481-cd777f131c60", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f513fcd0-6bed-4a8b-b77e-48ba7b11d856", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75c8218-bb99-49f7-a64a-33bbe75f16a4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchAdd" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38915138-a6aa-4f0a-85cb-36123a702fdb", "name": "Send an email based on a template", "request": { "name": "Send an email based on a template", "description": { "content": "Send an email based on a template", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0135de4d-7a0b-4b30-80e3-296843f42023", "name": "Accepted", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80c84f8f-3cf2-4abf-a134-8030375a4dcd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526fe658-0a37-4025-8477-c026406ce17b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87c64ac-82bd-4a2d-8556-cae0a2f20681", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "181771ea-f575-45b1-be59-b97919e24905", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcda5a92-4a44-43e4-bfaa-251c00eaf130", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9473eaf3-f053-4e41-8361-8fb6d5aa7ef6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d444a724-4007-4184-98a6-987baf7bf425", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48fa1c2a-2f33-42d3-8a78-b6b5ce4c0a70", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates:send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"template_id\": \"string\",\n \"user_id\": \"string\",\n \"address_field\": \"Email\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f320e4f-2671-4c6f-890a-83ee62167791", "name": "Retrieve an Email", "request": { "name": "Retrieve an Email", "description": { "content": "Retrieves a single Email that has been sent", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ab537423-83fd-4481-ae62-25b6eef3e573", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"subject\": \"Welcome to our service\",\n \"headers\": \"X-Custom-Header: value\",\n \"contact_id\": \"string\",\n \"sent_to_address\": \"john@example.com\",\n \"sent_to_cc_address_list\": [\n \"cc1@example.com\",\n \"cc2@example.com\"\n ],\n \"sent_to_bcc_address_list\": [\n \"bcc@example.com\"\n ],\n \"sent_from_address\": \"sender@company.com\",\n \"sent_from_reply_address\": \"reply@company.com\",\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"received_time\": \"2024-05-21T14:31:00Z\",\n \"opened_time\": \"2024-05-21T15:00:00Z\",\n \"clicked_time\": \"2024-05-21T15:05:00Z\",\n \"original_provider_id\": \"msg_abc123\",\n \"original_provider\": \"INFUSIONSOFT\",\n \"provider_source_id\": \"sync@company.com\",\n \"plain_content\": \"V2VsY29tZSB0byBvdXIgc2VydmljZQ==\",\n \"html_content\": \"PGgxPldlbGNvbWU8L2gxPg==\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f48a4b0-daa9-49fd-bf79-18a62b99f863", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e81fc9-99ac-4895-a1b2-f9d17354bf42", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed58c78-e9e5-461c-aa18-5b910314c3d8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc1a25d9-d2db-490b-aa56-d89110538868", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6209c531-48f5-4f14-9f26-00ebe0e8901a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8d59601-5733-424e-9bba-1ff6638a80f8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1368f771-e867-434b-9e00-d78df6c2b53e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d14e025-eee4-4dad-9bc5-4a95ebbf7768", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8926fbc4-ec99-4b7b-8305-1701fa3652fb", "name": "Delete an Email Record", "request": { "name": "Delete an Email Record", "description": { "content": "Deletes a specific Email Record", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0e774992-bdcc-4cfd-92d9-47303becf2d2", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2288f586-7775-4d9e-b536-7cc9de08edaa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0050a7ae-cf04-4616-93fe-cde010a7e44d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0240a20-d959-4a51-a9bb-a1f3aa4f04e2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dce9a61-9522-4b77-ac36-ece3a4671559", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d44f919-10a6-4028-8fb9-82f320e036e8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e1bd8c-e96b-4862-a0cb-14111ad1031a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4d0ea1-120b-4cde-bae1-56ba5fb9050e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd4e5e4-1849-4ac4-9b82-eca851f999ff", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22c8dc61-ced8-463b-a4ba-6b7f03349779", "name": "List email templates", "request": { "name": "List email templates", "description": { "content": "Retrieves a paginated list of email templates", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Search filter to apply to results" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "beed3551-92b1-4d13-96c3-931a94283b34", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_templates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3055d36-15f9-4616-b0ba-71f3c4683dc4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c51dbfd0-57bb-4c33-ab3c-46b8acacb656", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a4ae3b-ba24-4bbe-b76d-8fc0d69dd586", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a277ca50-98cc-480e-b2ca-9b97ae9d0229", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b37ab201-d654-49be-938c-c60531b89e03", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f19211-6130-40a4-9f64-1b497730b068", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f08d47f-08fe-4484-bbb2-976742978d63", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cafb936-362f-485c-832f-94cef2559277", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88fd9e85-841f-4240-a021-fc2ed6f28f01", "name": "Retrieve an email template", "request": { "name": "Retrieve an email template", "description": { "content": "Retrieve an email template", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6fe50605-eaa4-42c9-a62f-dcc289364f48", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 6058,\n \"piece_title\": \"Welcome Email\",\n \"categories\": [\n \"Marketing\",\n \"Onboarding\"\n ],\n \"from_address\": \"~Owner.Email~\",\n \"to_address\": \"~Contact.Email~\",\n \"cc_address\": \"manager@company.com\",\n \"bcc_address\": \"archive@company.com\",\n \"subject\": \"Welcome ~Contact.FirstName~!\",\n \"text_body\": \"Hello ~Contact.FirstName~, welcome!\",\n \"html_body\": \"

Welcome ~Contact.FirstName~!

\",\n \"content_type\": \"HTML\",\n \"merge_context\": \"Contact\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5ef3946-e798-4133-9a1c-6ec072b532ed", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f5769a-9eac-4086-9c14-e511d8e02933", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f1d12e6-23d4-4d0b-b8ec-c3cdd2785266", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9084a7e6-3cb7-4f24-bfa1-018f59a855cf", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f09cbac8-ec95-4f86-88cd-e3af66f735b0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4370d39-8ed7-46ce-9b0a-81274a29e866", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06d63184-0cf3-4da9-be54-98c543e322fc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d75ebf83-1da7-4738-9898-f5fca4d3dac2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emails", "templates", ":email_template_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email_template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "23b0dd6c-1f8a-4f7e-9c93-fb1ecd8133d9", "name": "Email Address", "description": { "content": "Email Address endpoints.", "type": "text/plain" }, "item": [ { "id": "bdf4bd3b-4151-4abf-a133-8ded5f1a0c2a", "name": "Retrieve an Email Address status", "request": { "name": "Retrieve an Email Address status", "description": { "content": "Retrieves the opt-in status for a given Email Address", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "39e6bb43-028f-4cbd-b243-fa25b0b8c94c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"create_time\": \"2024-05-21T14:30:00Z\",\n \"email\": \"john@example.com\",\n \"opted_in\": true,\n \"status\": \"SINGLE_OPT_IN\",\n \"last_click_time\": \"2024-05-21T15:05:00Z\",\n \"last_open_time\": \"2024-05-21T15:00:00Z\",\n \"last_sent_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24f8b85-2fee-4e7a-b8d6-8909c72d22ff", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7dba47b-b450-4ad7-90fb-6084421c7bae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484b9f98-a82d-4908-929f-8621a23b99f2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d92454a-1915-4c7d-9f9c-4ae0dfaae258", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1aa0706-48bd-41bf-a54e-49b51f80d301", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc1b6977-bb58-4d33-8c5c-34c45b87022a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9e3845-3e4d-42a8-9135-fcfad9883cbe", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99dd01de-06fd-4ac1-a105-5ebf5a85c06f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0f5ace2-4812-4807-80e0-609bd69a5876", "name": "Update an Email Address opt-in status", "request": { "name": "Update an Email Address opt-in status", "description": { "content": "Updates an Email Address opt-in status\n\nYou may opt-in or mark an email address as _Marketable_ by including the following field in the request JSON\nwith an opt-in reason. (This field is also shown in the complete request body sample.)\nThe reason you provide here will help with compliance.\nExample reasons: \"Customer opted-in through webform\", \"Company gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to `Unconfirmed` (marketable) for email addresses\nthat are currently in the following states:\n- `Unengaged Marketable`\n- `Unengaged Non-Marketable`\n- `Non-Marketable`\n- `Opt-Out: Manual`\n\nAll other existing statuses e.g. `List Unsubscribe`, `Opt-Out`, `System` etc will remain non-marketable and in their existing state.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5d27651-46a9-44a4-b84d-4a7af2e667c8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"create_time\": \"2024-05-21T14:30:00Z\",\n \"email\": \"john@example.com\",\n \"opted_in\": true,\n \"status\": \"SINGLE_OPT_IN\",\n \"last_click_time\": \"2024-05-21T15:05:00Z\",\n \"last_open_time\": \"2024-05-21T15:00:00Z\",\n \"last_sent_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9fb1a46-610b-46bd-8f1e-e9700e759453", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51ec20d8-a1f5-4ad0-a8be-870f711d30c7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7356f40e-b01c-4aa3-8674-52dfc42bfab3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99e24a9f-f468-4037-ac21-ffc6b109665a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7feaffdf-6c08-4826-940a-5c5ba3424b5a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "661e9324-b843-425b-96a6-6354f264b11a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a4839be-6517-4624-8a0f-edbbcaf1fb62", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f9d102-e518-4356-81d6-4f1df1f48d18", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses", ":email", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "email", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opted_in\": true,\n \"reason\": \"Customer requested to receive marketing emails\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f701875-24b2-4f3a-8eb4-252a17ef0c98", "name": "List Email Address Statuses", "request": { "name": "List Email Address Statuses", "description": { "content": "Retrieve a list of the Status of Email Addresses", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "filter=opted_in%3D%3Dtrue", "description": "Filter to apply, allowed fields are:\n- (Set[String]) `emails`\n- (Set[EmailOptStatus]) `statuses`\n- (Boolean) `opted_in`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\nFor the filters listed above, here are some examples:\n- `filter=opted_in%3D%3Dtrue`\n- `filter=emails%3D%3Dexample%40test.com`\n- `filter=emails%3D%3Dexample%40test.com%2Csecond%40test.com`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "order_by=last_sent_time desc", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `email`\n- `status`\n- `create_time`\n- `last_click_time`\n- `last_open_time`\n- `last_sent_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8cfe35e2-dd38-4ecc-a074-61f37db6d742", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12bd14c3-18f7-43ac-842b-3aa44dd57a9d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37d2305e-5859-4cfd-9e5a-100fb9e6f248", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a95e2e-414b-4cd6-a330-98dcb6cc968f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb5d369-fa10-436b-8000-039a77a8794b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab52650b-a4cd-46cd-b5a0-6b45262755e9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "437063d5-60a6-4995-a297-a0e8de1946e9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "849cee11-6e58-4cf9-9310-54b0a2861221", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "804fd159-f425-4fca-beeb-346dcb93be4f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "emailAddresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "filter=opted_in%3D%3Dtrue" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "order_by=last_sent_time desc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4f87b051-dd13-4c54-813e-545ecd122215", "name": "Files", "description": { "content": "Files endpoints.", "type": "text/plain" }, "item": [ { "id": "30318503-68f6-4658-b6cb-2bc5953190ab", "name": "List all files", "request": { "name": "List all files", "description": { "content": "Retrieves a list of files", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (Boolean) `is_public` — `true` (public) or `false` (private)\n- (String) `contact_id`\n- (String) `user_id`\n- (FileBoxCategory) `category` — one of: `ATTACHMENTS`, `CART`, `DOCUMENTS`, `HIDDEN`, `INVOICE`, `LOGO`, `TICKETS`, `WEB_FORM`, `FUNNEL`\n- (FileBoxType) `file_box_type` — one of: `APPLICATION`, `IMAGE`, `FAX`, `ATTACHMENT`, `TICKET`, `CONTACT`, `DIGITAL_PRODUCT`, `IMPORT`, `HIDDEN`, `WEB_FORM`, `STYLED_CART`, `RESAMPLED_IMAGE`, `TEMPLATE_THUMBNAIL`, `FUNNEL`, `LOGO_THUMBNAIL`, `UNLAYER`, `BRANDING_CENTER_LOGO`\n- (String) `file_name`\n- (String) `created_time`\n- (String) `updated_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. Multiple filters are combined with a semicolon (`;`, encoded `%3B`)\nand are ANDed together. For the filters listed above, here are some examples:\n- `filter=contact_id%3D%3D123`\n- `filter=is_public%3D%3Dfalse`\n- `filter=category%3D%3DDOCUMENTS`\n- `filter=file_box_type%3D%3DTICKET%3Bcategory%3D%3DATTACHMENTS`\n- `filter=file_box_type%3D%3DCONTACT%3Bis_public%3D%3Dfalse`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `file_name`\n- `updated_time`\n- ...\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "160d2ae5-e139-46d5-b9de-4145d3507021", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1169a8da-3065-48af-98d9-43034e2f6a7d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7181755-c87f-4415-9c51-04e1383e1461", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a8cc2d-516e-4541-b31f-313017fd8a4e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da4164a1-4169-493c-bc11-b594459dffe1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6dbbc8b-5b1e-4a28-9815-73519f48ea1e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eabe30b-fe8f-4395-82a5-f04646892689", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7ebbd7a-c2b9-46af-9436-4cdadae94b76", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc2a695-b3ee-43b1-b243-9be453b9353e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab3d3990-0a91-483d-b996-94cdefc76095", "name": "Create a file", "request": { "name": "Create a file", "description": { "content": "Uploads a file using multipart/form-data. The `file` part contains the binary file content; `file_name`, `is_public`, `file_association`, and optionally `contact_id` are additional text parts in the same multipart request. Sending these as URL query parameters is not supported.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) File to upload" }, { "key": "file_association", "value": "string", "type": "text", "description": "(Required) File association" }, { "key": "file_name", "value": "string", "type": "text", "description": "(Required) File name" }, { "key": "contact_id", "value": "string", "type": "text", "description": "Contact ID. Required if the `file_association` is CONTACT" }, { "key": "is_public", "value": "string", "type": "text", "description": "Is public" } ] } }, "response": [ { "id": "64fd1902-43ca-4a02-8c34-d09f492293a5", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"DOCUMENTS\",\n \"file_name\": \"document.pdf\",\n \"is_public\": false,\n \"contact_id\": \"string\",\n \"created_by_id\": \"string\",\n \"remote_file_key\": \"files/12345/document.pdf\",\n \"file_box_type\": \"APPLICATION\",\n \"file_size\": 1048576,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06957a5c-bd22-4b05-b9a3-265ac1087c62", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa6d5b54-65ec-4fac-99b1-021fc4b1777f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b79a3f6-d33c-43a7-a782-b81dc4057a11", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37e2a35e-0a7e-419f-b28a-da0ece07c621", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c183390-5eb1-427c-99e9-6fb9d63e6d55", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be528f7-161e-46b1-a6e5-1d80f9bcf4d1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89bfb38b-13ea-4aa7-b9ce-e3f07a3e9b61", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d00c756-067e-4649-a42d-7bb7c67243e4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) File association", "type": "text/plain" }, "key": "file_association", "value": "string", "type": "text" }, { "description": { "content": "(Required) File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Contact ID. Required if the `file_association` is CONTACT", "type": "text/plain" }, "key": "contact_id", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "string", "type": "text" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1857f720-23ec-40df-8161-dfc0975374e9", "name": "Retrieve a file", "request": { "name": "Retrieve a file", "description": { "content": "Retrieves a file", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f5bf3685-03eb-409e-9680-5a0910ab9289", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"DOCUMENTS\",\n \"file_name\": \"document.pdf\",\n \"is_public\": false,\n \"contact_id\": \"string\",\n \"created_by_id\": \"string\",\n \"remote_file_key\": \"files/12345/document.pdf\",\n \"file_box_type\": \"APPLICATION\",\n \"file_size\": 1048576,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c4b818a-a8c6-4829-b659-e418fa6ebd5b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60717691-5509-42fa-96b3-0112df1835c5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10742aae-7969-4f42-bd46-8653efefe2cd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29c08c58-c66f-4b89-bff4-92fa7f35e42c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "292b63c0-a6ea-4a4d-bed3-a6b5e9a0b602", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a27cc025-240f-4292-8a7a-8577f47406ce", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b93876-c054-446f-8617-bb6c1332f75e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7648f8d8-2fd2-4732-acd0-9bf31da97503", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebb0b72e-9fe2-4f61-8f4d-066dd6963924", "name": "Update a file", "request": { "name": "Update a file", "description": { "content": "Updates a file using multipart/form-data. Note that this endpoint uses POST instead of PATCH.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "file", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "file_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File to upload" }, { "key": "file_name", "value": "string", "type": "text", "description": "File name" }, { "key": "is_public", "value": "false", "type": "text", "description": "Is public" } ] } }, "response": [ { "id": "fe93e301-9ac6-4217-8d61-ff47134da2a6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"category\": \"DOCUMENTS\",\n \"file_name\": \"document.pdf\",\n \"is_public\": false,\n \"contact_id\": \"string\",\n \"created_by_id\": \"string\",\n \"remote_file_key\": \"files/12345/document.pdf\",\n \"file_box_type\": \"APPLICATION\",\n \"file_size\": 1048576,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138767ee-c80e-4b7a-8451-5c0a4b4b080f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b673da6-acaa-4df4-8c64-413cf04f1143", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150e1da1-005a-4ada-8c7f-a3f92b4e4aa7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f62ece04-f72a-4f4f-9bd4-f468d6d00008", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d97ca4-c28b-4fe1-9413-2b3e7312d0bc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2da40e4-04ea-41e7-9fad-3c85a2f6eb1c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e56f0415-f956-471f-b9a9-6db5c8a87914", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e39dbc70-0fbf-4fb2-af4c-bde56f0cdc38", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "is_public" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "File name", "type": "text/plain" }, "key": "file_name", "value": "string", "type": "text" }, { "description": { "content": "Is public", "type": "text/plain" }, "key": "is_public", "value": "false", "type": "text" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a81cde3-2d06-47c4-948c-6c4ed8b12b09", "name": "Delete a file", "request": { "name": "Delete a file", "description": { "content": "Deletes a specified file", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ab0ef343-6e9d-4ae8-8f07-5ff2bbda4504", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad000619-c39e-421c-ad50-84b278dd1192", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a3b16e-03d0-44fd-ba9f-1fc3cca66f50", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ca14757-b935-4d86-8247-78a030fef589", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3bbed65-e384-4f86-bb16-3e161f01e98f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73b7ab20-ed32-4b03-985d-55abdaf3bf37", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe77876-8301-4d43-bd9f-00502ca4c509", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e74f756-8fe8-4f37-a4fb-f5c07e734d93", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd39cd1f-eb78-4c62-9eed-eddfaf66113c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4d8fd57-e433-416a-8be0-0e231f5346c8", "name": "Retrieve a file's data", "request": { "name": "Retrieve a file's data", "description": { "content": "Retrieves a file's data", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cc8efcae-77cb-48fb-8f66-df8346cd9b82", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9803292a-71b1-49f6-8c2a-f280fa372ec3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77a80ec-f87e-476b-8e49-2dde49f06941", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c41e76f8-6555-441c-ae97-34e1411ffad3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09501f78-23b6-4dad-b56b-58451b4839de", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4b02bd6-aaab-4d87-8811-63009dbea1a8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4865fe95-c5d4-48bf-87de-683e83a24689", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "778a6bed-b5b8-4e92-8b3d-f8025183c15d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "335d75b5-136a-48cb-b8b0-02cd93afcf7b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", "{{file_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "371dad11-3a36-4386-a659-41c2f1323803", "name": "Free Trial Discounts", "description": { "content": "Free Trial Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "f914cd18-ef91-4178-80c0-149240f7aefc", "name": "List all Subscription Free Trial Discounts", "request": { "name": "List all Subscription Free Trial Discounts", "description": { "content": "Retrieves a list of Subscription Free Trial Discounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (Integer) `free_trial_days`\n- (Boolean) `hide_price`\n- (String) `subscription_plan_id`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=free_trial_days%3D%3D14`\n- `filter=hide_price%3D%3DTrue`\n- `filter=subscription_plan_id%3D%3DmySubscriptionPlanId`\n- `filter=free_trial_days%3D%3D14%3Bhide_price%3D%3DFalse`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `free_trial_days`\n- `hide_price`\n- `id`\n- `name`\n- `subscription_plan_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a544423b-c24c-489f-89af-1961cc022ec7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"discounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b3a7e82-f0cb-4ecc-9966-b16c0601b213", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd1fd917-0c57-4a05-8a4a-6c7627d9ba34", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbfae273-b8ea-45f2-8e25-87bd4f0a62c9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1827fe5-6e22-4685-8cfb-4159886b074c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02dc9074-9161-457a-a203-3c55dfe2bafd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34058abb-a18b-40e2-8723-b5bbe7db6ed4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150342b5-9a72-4394-ad59-f405d895cce1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de719aa3-8909-401b-96ca-bfe99a3905ac", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8f33c55-994b-459a-8883-2934de6d6fb8", "name": "Create a Subscription Free Trial Discount", "request": { "name": "Create a Subscription Free Trial Discount", "description": { "content": "Creates a Subscription Free Trial Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dbab677c-ddd7-4886-aeaa-a243fe095168", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\",\n \"free_trial_days\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cf8f7f6-aa8c-480f-87c0-7712380537a3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28f327f0-376d-4920-a7f1-2e123eb3694c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66a4e5bc-e69e-4ea0-a250-9a7a303393fc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c38490-d82c-4f65-82c8-f43187adfb75", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af8a02c8-1208-4c94-80ff-85aa3e78f2ba", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b2c77f-f1fb-4dac-a9ec-d4957a567ed9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "714ad96e-f6cb-41ab-9e3d-d3ea274bdaf0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900b1012-6a0b-4077-89b1-f61a8c377dd1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"subscription_plan_id\": \"string\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"free_trial_days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9cd42664-863c-414f-84a3-2d589360f9c4", "name": "Create a Subscription Free Trial Discount Criteria", "request": { "name": "Create a Subscription Free Trial Discount Criteria", "description": { "content": "Creates a Subscription Free Trial Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e356af3-3125-4ba9-8e60-e75ded7a7e12", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"criteria_id\": \"string\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b94ea4e-a9e3-4ed4-911a-4172efd97773", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8536bd17-31e5-42f7-bae1-3343f8bd9ecd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a123e9-01d5-4b22-af93-02df6cbae1e6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "570fdc17-18fd-4b34-8f6b-15e9fa838d61", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96207a9d-3bbb-440f-a809-621093788530", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c2ec1a9-53b9-46e2-ac3d-130ee386b8fd", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "319b5da8-ea57-4c3b-84a7-d8799f0199d7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e87ac2c-cb2f-40f7-ac17-5bc58c31115a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53e38b6e-ba54-4cb7-ba6a-60624db8c170", "name": "Retrieve a Subscription Free Trial Discount", "request": { "name": "Retrieve a Subscription Free Trial Discount", "description": { "content": "Retrieves a Subscription Free Trial Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a4f4740d-6045-4a2b-8314-d583c3401b20", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\",\n \"free_trial_days\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3d997a4-310a-4bdd-aa18-2e07358bf735", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78923996-c5e7-4e20-896a-02c64aec13cc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6622e28-3fac-4f6c-9e98-6c5316dd6c2b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48016103-6f2e-425e-90fb-fd438b8282cd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f34b1f23-02a2-486e-9e83-bb99dafd738a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2586d1b5-36ad-41bd-b595-464da954a87c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb0d262f-4897-4ed7-8315-45d01d0386a7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5be9427a-4b93-4ccf-811f-28cef9cd9f48", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4870087-9e72-4bf4-8cf5-2719e0ef5d37", "name": "Delete a Subscription Free Trial Discount", "request": { "name": "Delete a Subscription Free Trial Discount", "description": { "content": "Deletes a specified Subscription Free Trial Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "de1d16bd-b75a-4c92-89fe-bb783b775a45", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c88145b-963e-425c-9f3e-f10898044edd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55b3e0c3-23c8-433d-8fe0-7f65bf28d00b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "550eb48e-f132-4ae5-bfc1-24338d6bdd5c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd38eb17-d3b2-41d1-b9e4-5c9fda5c0851", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2691fc-88c7-4afe-893f-7546d9b32a03", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdb2b4fa-d210-4de0-9f42-87777b9c9723", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec0c04a4-2c0e-4a97-a42e-3a9180092e73", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b51e5657-d024-436e-bf43-9ab3d74da079", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d627843-ca2c-4fbd-bf9b-c85e386ea64b", "name": "Update a Subscription Free Trial Discount", "request": { "name": "Update a Subscription Free Trial Discount", "description": { "content": "Updates a Subscription Free Trial Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "criteria", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bfb9302f-cf8d-4358-a169-9c1808d79f0e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\",\n \"free_trial_days\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5acda22-4ea0-4d76-902d-339e164d72f3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526ce974-d7af-4eca-81a1-68beb96529e3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b9698b5-3f4a-4286-a455-72b85ec7ccea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41a8e6a8-2d23-4588-ae4a-d07c15a2460b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96ca3440-9dd6-47e5-be4d-17b4629a4bf5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1f95f45-2111-4230-8c25-2483e937b125", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a562d3-4e9c-4a8b-ac64-b8d568664718", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa261d0-c7f1-44db-8573-6af6e11788a3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b77805bb-d5f2-4e0a-bd3b-8cb9feadb022", "name": "Delete a Subscription Free Trial Discount Criteria", "request": { "name": "Delete a Subscription Free Trial Discount Criteria", "description": { "content": "Deletes a specified Subscription Free Trial Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "73f42c44-716e-491c-8764-b237fc431f3d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a35507ba-01e3-4fa9-bb50-17fa5b6eaabb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c51d9119-ab15-4a21-ab6a-810ed6f4acfb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393a96d6-d078-49cb-98b3-a7483ebd99c7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cbb8ea3-a66e-435f-9280-3aa1b19ddde2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f7ceab-7275-4657-88df-d8efed8dd8df", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc17d8ab-0bc0-44f0-9d70-2acd0bb69711", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080734a0-6bda-4e1b-88ca-a7dce5e27af9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c87e66c-9a49-472c-8a5b-7f89baa05c23", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7b030343-cddb-4b06-949a-f87c8ee8ebb9", "name": "Integrations", "description": { "content": "Integrations endpoints.", "type": "text/plain" }, "item": [ { "id": "a51926c8-df20-4fc4-b00d-3d82f059694d", "name": "List WordPress Opt-In Options", "request": { "name": "List WordPress Opt-In Options", "description": { "content": "Retrieves the list of WordPress Opt-In Options available", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b97b3bf7-c44e-47c2-b248-c2221519e203", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wordpress_opt_in_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2315a43-785f-44e2-899a-e5cfaa0cc493", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87c347b-8102-4dca-8932-69fbf7a3e5d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e0acd8-08c3-4760-9a39-0e38176d52b2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03645d9a-bcc4-40eb-91c3-901cd9798e2c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c286f4ca-0c94-4f5c-a4c8-b17196d26e4d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c0b8a8b-4678-4583-898e-c4d4412fb269", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58614b9f-6621-46df-98c7-15f27fb29a0e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf47de2-9c5b-4b4b-ae26-fa3b3227cf58", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ee74070-6a96-4182-b17a-3fb15df1546f", "name": "Add a WordPress Opt-In Option", "request": { "name": "Add a WordPress Opt-In Option", "description": { "content": "Adds a value to the list of WordPress Opt-In Options Available", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ae074361-f0d6-4e65-be5f-820968fc90aa", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fdd26c-6b6d-453d-ae56-79ac493b0f3a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "365b8010-0803-4b96-8f8e-e950e6e92673", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c04e63a-3286-470a-8f95-8ccef689d7fe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a693b01-0092-4d2a-bcbf-1f5f19d7b44c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed69bc4-1311-4004-9ab6-f03a04f1f5cb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "316d901d-4c2e-410c-b98e-948da0cf21fc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77e3f939-43b7-4804-bb6c-59293885c015", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12973504-c5c3-4ea5-ac85-a7f2c4b8fa9e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key\": \"NewsletterOptIn\",\n \"name\": \"Newsletter Opt-In\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3032177-e541-41eb-99ac-fc56b934faf8", "name": "Achieve a WordPress Opt-In Goal", "request": { "name": "Achieve a WordPress Opt-In Goal", "description": { "content": "Achieves a WordPress Opt-In Option Goal", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f41a40c9-6f17-4297-913c-16d169ab2c49", "name": "Accepted", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successful\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc3f211-282a-4e7b-b6aa-0a9bf298a549", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8ce2b6c-95e4-4445-9d93-41e65d7f8bb8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb52d0dc-00af-416d-ac43-5aa25b2522f7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f08a930-f7fe-4d5d-9bea-dd79ed5b8df0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1842b857-7fe9-4f6a-bb2a-a31d1183a174", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a52e74c1-61ce-4436-aa56-bbb140e13899", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "273f3a15-18d2-4d4f-9951-916ee16fb1e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb4138a-ce05-4e5c-ac49-46ecf4b20db4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", "{{option_key}}:achieve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"d05dc112-3c92-4aaf-b2fa-00cc6cb452ec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1235002b-9173-4310-bed9-4e48d70575b7", "name": "Delete a WordPress Opt-In Option", "request": { "name": "Delete a WordPress Opt-In Option", "description": { "content": "Deletes a value from the list of WordPress Opt-In Options Available", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4019fb4a-7620-4ae3-a72a-58fd5df6a568", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60c4ddc7-d11e-4c1e-9d40-afa277fa224b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9516ac08-d49d-4858-b2b0-2499b0d7cc57", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4bbe02-f987-4311-9fef-db3fb119f07d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbdcafc9-3966-41e8-9e14-fd750c48402d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bc7d0be-a52e-4ab4-8abe-0822c7acf53f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e752a2-fa87-4cc0-9bbe-46296210fe71", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213aa67f-c115-4df9-9d60-118686bb2c7f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b787f573-c8d3-476b-b549-f8bf0a6a8f8d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "integrations", "wordpress", "options", ":option_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "option_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "281c5fa9-d99c-43f0-be1f-95b62eed8a1e", "name": "Lead Source Categories", "description": { "content": "Lead Source Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "ad9cae89-cf32-40c1-b83f-70930f7356db", "name": "List Lead Source Categories", "request": { "name": "List Lead Source Categories", "description": { "content": "Retrieves a list of Lead Source Categories", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `name` - Wildcard matching allowed\n- (String) `description` - Wildcard matching allowed\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor prefix matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n\nFor the filters listed above, here are some examples:\n\n- `filter=name%3D%3Dexample`\n- `filter=name%3D%3Dexam*` (starts with \"exam\")\n- `filter=description%3D%3Dexample`\n- `filter=description%3D%3Dexam*` (starts with \"exam\")\n- `filter=name%3D%3Dexam*%3Bdescription%3D%3Dsales` (multiple filters combined)" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0c327be5-d7ab-467e-a0d5-5e59336f3cce", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_source_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a57f621-1143-4756-8711-212a8eef994b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd1bb1a2-0c71-4dfb-8109-3052c110fe4e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a0bf12-274b-4244-a452-224d7a80b2f5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb5cd1b0-16c3-4fe3-ad32-cdb629234ab2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a66a9bee-59d7-4223-9441-4e8170e35a25", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2757c0e6-79cf-424c-84eb-60fe6fad360c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f4469a-9b28-4f6a-99ac-10b6e86d6966", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "447f95eb-767b-4abc-8b62-dcde07a5a499", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9eab1298-2164-4067-82f1-55ff85fa549a", "name": "Create a Lead Source Category", "request": { "name": "Create a Lead Source Category", "description": { "content": "Creates a new Lead Source Category.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "898c5568-4671-44aa-8715-120bb6288915", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f8ab74-b289-49a3-aa73-9c75f966178c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2902536f-c631-481b-8fd4-636f31cca812", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4f4a6ec-fc9e-4dbc-a8b1-82db2af37f87", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aee06cc-458f-4f79-a74a-b13eab51bf63", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "917752cf-02e4-4375-b5d7-2642ad7f89c6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751a9786-26db-49e4-a31a-2739e8875118", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0b57932-1d4a-4388-8451-2e399b9be16c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d1618d5-2d0a-425c-87d6-36d912141aba", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "468faf00-e0d8-4408-9bcd-e88e5ff20d85", "name": "Retrieve a Lead Source Category", "request": { "name": "Retrieve a Lead Source Category", "description": { "content": "Retrieves a single Lead Source Category for a given ID", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bb29c93c-6af4-43d4-8507-7efa35fdb594", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d867a5-a43f-4b72-b682-0e16c3e1d187", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "479bc64b-c0ee-4d5b-801c-ea9430a0c216", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3043711f-e9c8-4008-bd86-adce0a1c5baa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34dca8a4-dab3-4812-be59-e7f69f325c5f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a98283-16aa-4537-b7bc-8923bef488be", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb989ec-cb35-4595-921a-bdf4a3b67938", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa57747b-181f-43be-9b96-c19d8089aa52", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db8d9f8-2715-4732-8bb5-119560d5b779", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a70df75e-f84f-4e2b-ba9c-db8d2567c108", "name": "Delete a Lead Source Category", "request": { "name": "Delete a Lead Source Category", "description": { "content": "Deletes the specified Lead Source Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e0178018-26d5-4c2a-86f0-d5271c92e4ae", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd744770-2d19-496c-8796-454f686359d2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42cf7178-9d90-49a2-a8ee-999cdef2b97a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "991ae638-6e29-4f41-ac78-53e176cca960", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "102be946-ff0b-4dc7-b654-70530b6309d3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76906224-52a6-459a-95a8-a940e1fecca3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "390cb9ad-92c8-43b5-9042-bc71fcd448ec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cace1ac-ef08-40d9-87df-c7a51df42f1d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e10bb6da-e157-4f49-950d-0f017cd4501e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7cddc25-509a-427a-865e-7108dc6928cd", "name": "Update a Lead Source Category", "request": { "name": "Update a Lead Source Category", "description": { "content": "Updates a Lead Source Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cac21aac-ce63-4cab-8f54-e76433c19e44", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6160759-8ff2-42e7-a6d8-cf668960026f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d2bf924-b54b-4922-984c-2cbc190a73b5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f8ff00d-fed5-47c9-b971-e0c9e7031734", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e63eb2c2-1e55-4246-829e-641ba49f0abd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4213e4-af77-42f1-be16-1dfecd165b13", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b43c628f-7087-49cb-ac6b-0b3cda06497f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704c719c-4baf-4e69-b4c4-44f10dce17bd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690f111e-9d5b-4447-bfbc-71f8ee9c6b00", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "12d09b77-454e-485a-8238-d9518fe4e408", "name": "Lead Source Expenses", "description": { "content": "Lead Source Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "c2b13406-4a00-4f6f-951a-3ebb1f4883d1", "name": "List Lead Source Expenses", "request": { "name": "List Lead Source Expenses", "description": { "content": "Retrieves a list of lead source expenses", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `title`\n- (Long) `amount`\n- (String) `incurred_time`\n- (String) `create_time`\n- (String) `update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n\n- `filter=amount%3D%3D2500`\n- `filter=incurred_time%3D%3D2024-12-22T01:00:00.000Z`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n\n- `title`\n- `amount`\n- `incurred_time`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6db9ad25-d80c-4434-a888-6cad0bea826d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_source_expenses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb1ed92-fd6b-4b28-abd8-efda740adb26", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba35a417-9539-44f3-864a-3b5f83e7ba07", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e72f6b2-d748-4e91-ae79-de3a2b19e8fa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c6eec3-f0e0-4b8a-ac25-18b323ab5b89", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deceea60-066e-477e-a059-d7eda3f2c597", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ce34848-7a48-4ca5-92d0-9b185b28be3f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ebd32ec-ad60-47d6-acf6-a79d2e61d5a9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19f58316-85c1-4043-831f-4ca9005c54cf", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to. Use '-' as a wildcard (e.g. /v2/leadSources/-/expenses)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df936551-c4a5-492b-9ff4-5b32ccf10c88", "name": "Create a Lead Source Expense", "request": { "name": "Create a Lead Source Expense", "description": { "content": "Creates a new Lead Source Expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d0da901-fd56-4c1f-9ca3-800b9908de74", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"lead_source_recurring_expense_id\": \"string\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f09f22a9-2bcb-4d70-abcc-a995f940ea30", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff3a93d2-8f5d-4cca-9654-3fbb1b58ebef", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24783e26-eb8e-45c6-b990-81fa047749ec", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd994009-492e-408f-87a1-28e1bef3229f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2cec971-c990-4b85-85bd-7875b50cbc01", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1466a5b0-5cee-4575-acf8-383bbd265e60", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5840570-0555-4aec-8698-9eabcb18e950", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61fe2527-8e91-4280-b5de-25c121591517", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce850a72-6b9f-4dfe-b362-df1c5a41b7a1", "name": "Retrieve a Lead Source Expense", "request": { "name": "Retrieve a Lead Source Expense", "description": { "content": "Retrieves a single Lead Source Expense for a given ID", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0fe4bed9-c268-4079-bf24-3acbf2a35c89", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"lead_source_recurring_expense_id\": \"string\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f636338-16c1-48e5-ad7d-761aefd95e34", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82924eb8-180b-41ec-a252-ade8e913a2e3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7310cf9-fdf7-4154-b1fd-f29a98c8b05d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a599a258-3dea-4df6-ae72-853a0abb318a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b5cc6a-083e-4382-82e3-796729dd195a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31178813-b1b6-4215-8d1a-d51e1e49ed3e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ed8c9c2-9ad5-4f0e-b023-b43ec8579462", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f93baf0-3c8c-4740-8685-f6c00c95664b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4029ba24-4f4f-478e-8a69-9d3f91cb2ae9", "name": "Delete a lead source expense", "request": { "name": "Delete a lead source expense", "description": { "content": "Deletes a lead source expense by ID", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "33cfe8bd-1486-4b10-a06d-98ce22a19bb9", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "063d098f-b281-414c-8ded-2c7fbb48ff0a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc92bac1-da1c-4bbb-97f9-1345edb152ef", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70b0dc60-a911-454d-8a8e-84ae29eafaab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17fe1890-4f04-4705-865a-1ccbab61fd2c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00503fd5-8823-49a0-b108-c9b47646ff1e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c0f0f04-c0fc-4713-9db7-5cc9307cf150", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88244a91-bed6-479e-98d9-70cfc93876fa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ac55651-1da9-4eed-8de4-9a1ba83ed449", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c562f08-03bb-4edc-ae91-134514348905", "name": "Update a Lead Source Expense", "request": { "name": "Update a Lead Source Expense", "description": { "content": "Updates a new Lead Source Expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "amount", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "title", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7cb5bcf4-2238-4c26-89e3-d777e778d45d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"lead_source_recurring_expense_id\": \"string\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa787f0e-e28d-401e-ba43-8e799471d214", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb969db8-4f8d-4731-85d4-061533baae84", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "708cd0ea-98c1-4e01-b9e3-e61b266013d7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e624d389-7bf1-4c29-a9fe-4d56001ce421", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf31e14-4c73-43ad-8bcf-1204bd549720", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df6aef65-f827-4823-a9f6-3cbff60e32f5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be993ab2-351d-43a0-8120-a327df6ce1df", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f84a77a5-9584-4631-a21a-4bb0098aa14e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8324c278-9785-49f1-b62a-668b56c3eb2a", "name": "Lead Source Recurring Expenses", "description": { "content": "Lead Source Recurring Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "8fc5a3b4-9d88-4283-8a5e-dd721038fd08", "name": "Retrieves a list of lead source recurring expenses", "request": { "name": "Retrieves a list of lead source recurring expenses", "description": { "content": "Retrieves a list of recurring expenses with lead_source_id and optional 'filter' query param", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `title`\n- (Long) `amount`\n- (String) `start_time`\n- (String) `end_time`\n- (String) `next_expense_time`\n- (String) `create_time`\n- (String) `update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n\n- `filter=amount%3D%3D2500`\n- `filter=next_expense_time%3D%3D2024-12-22T01:00:00.000Z`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `title`\n- `amount`\n- `start_time`\n- `end_time`\n- `next_expense_time`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4bb4cd63-9c59-4302-97dd-6f1585ae6a7d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_source_recurring_expenses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "100c4544-045b-45bd-b199-6c0c98748789", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c8ab6a-4a3d-40ee-9c61-f55a0627a88a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf5525bd-a411-47c1-9525-380d3e147e4f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df204ed-98f7-45a8-89c8-f523f8fac87c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab32692-a36f-4dac-85ff-bffba94802aa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79dfa0b-03eb-4a1e-b06d-db55460e0358", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a785c00b-4cf1-4412-94f1-8dd68d84ba85", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67df5805-92be-4ddb-8cd9-c8f1b64b9453", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "-", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to. Use '-' as a wildcard to list recurring expenses across all lead sources." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6da9151-e0a3-4cf0-b533-83ab8e204c99", "name": "Create a Lead Source Recurring Expense", "request": { "name": "Create a Lead Source Recurring Expense", "description": { "content": "Creates a new Lead Source Recurring Expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "41cc7811-5e3b-4d29-a4d1-f6b0941866eb", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"next_expense_time\": \"2024-04-01T00:00:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd552724-cc57-40c4-bfc8-b5efd4fcb260", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56c6575f-6374-47a9-a932-1623db896ead", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9851acef-3ff1-46bf-bda0-52c268f8c9af", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caea4365-6ff0-4671-9922-7d5cdb67d132", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ae5ee44-3222-4ac4-a74a-e5fe202c1765", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2525d197-4f37-421a-ac41-12244fbd86e8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5ef77ad-2d08-4e16-9012-6074d2960d14", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb446e86-7268-4c43-9fc9-23beeadaa069", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 22550,\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65ac5dc5-9385-4fa3-8c7c-dd03754cd204", "name": "Retrieve a Lead Source Recurring Expense", "request": { "name": "Retrieve a Lead Source Recurring Expense", "description": { "content": "Retrieves a Lead Source Recurring Expense using leadSourceId and leadSourceRecurringExpenseId", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "18a5ac72-9252-4c92-ae9a-e05d307972f2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"next_expense_time\": \"2024-04-01T00:00:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea6c6a5-20be-43f8-a8e2-9b563ff8da74", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb8e87a-4c40-4fb3-9173-64c62115420e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a890710c-b230-40db-8687-8752d0604834", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d89d6a14-41b6-4ea6-bb09-dff97d86f445", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "974ddbc9-63da-4ba4-b2b2-0c81136e2c52", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05d075a-e51c-40d6-a68e-92b55762d6b8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1cfab18-376c-45ec-9534-68fa6549db0e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502fbe3e-8d0a-48ed-8e51-7660d7a8e6d3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e42a78b3-92df-43f3-9642-a9fe3515b233", "name": "Delete a Lead Source Recurring Expense", "request": { "name": "Delete a Lead Source Recurring Expense", "description": { "content": "Deletes a new Lead Source Recurring Expense that belongs to a Lead Source", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f9bef707-8f3c-43fe-9c2a-ec7e7c3de136", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61e234c9-f441-4346-a0c7-3ec949881320", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ea6d03-3ced-4a0e-9272-1cf21576b969", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c281f79-8d46-4e10-89d3-0cfa95fb9035", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178ee58e-5e95-480d-8ef9-1a3ee1a0e8d1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7fefeb5-9f52-45d0-8f6c-7122c05bceed", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88f174d6-36db-46df-b979-6f4261e5109f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adea4aff-5dc8-45c1-aab5-29749d9fe7e5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6939926-a43d-40b3-9678-0f23bb8f67b2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68f39b26-683b-46e4-b149-782668d57cae", "name": "Update a Lead Source Recurring Expense", "request": { "name": "Update a Lead Source Recurring Expense", "description": { "content": "Updates a Lead Source Recurring Expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "amount", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "end_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "941753c3-ebb8-4cf1-a009-9a46d431688d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"next_expense_time\": \"2024-04-01T00:00:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a544d50b-820b-4393-9e4e-b54cb976de7c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a1bb8a-b359-4f4b-a0bd-d9e30afc806a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24708bb2-7929-4332-abef-24540d7cb9da", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa422b98-4275-4eb7-a9e3-c8f1039b8557", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ca8a24-9d07-415e-b46a-46bbe91e9053", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06168b5-aea0-45fe-a33b-54976b4142a2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ff9394-57fc-4f61-a5b1-0448c9cc946a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4658a8d0-46ec-46aa-8d96-78a2d084b4ed", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "start_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84caeab9-a4e1-438d-8c4b-922521379628", "name": "Retrieves a list of expenses incurred from a recurring expense", "request": { "name": "Retrieves a list of expenses incurred from a recurring expense", "description": { "content": "Retrieves a list of expenses incurred from a recurring expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `title`\n- (Long) `amount`\n- (String) `incurred_time`\n- (String) `create_time`\n- (String) `update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n\n- `filter=amount%3D%3D2500`\n- `filter=incurred_time%3D%3D2024-12-22T01:00:00.000Z`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n\n- `title`\n- `amount`\n- `incurred_time`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "44d4f82a-1b6a-423c-ad05-f3fca13c2951", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_source_expenses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa1d28e1-8230-4002-adca-0aeb2f513ae6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42801f76-f180-43db-a62d-1c3caff69941", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5078e433-02a2-42f2-aa8e-8e4079adf64d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "064c1c97-2bbf-4d59-b18e-2f59ebf04991", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3067e16-4384-4455-8563-895703b7a3db", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48084fe1-d0f1-4cde-9113-2d1239ab6844", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902fcd3e-ea6c-4ed1-9460-8a2074fa9a66", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a39b9d2d-cb83-432c-b7c6-98ab2e6b1978", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id", "expenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c4cfb3da-c156-44bd-84e9-4aa9d913de4f", "name": "Lead Sources", "description": { "content": "Lead Sources endpoints.", "type": "text/plain" }, "item": [ { "id": "0faeaac4-940a-4e2d-9183-2636b2ce1bcc", "name": "List Lead Sources", "request": { "name": "List Lead Sources", "description": { "content": "Retrieves a list of Lead Sources", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `id` - Must be a positive integer. Allowable operators: \"==\", \"<=\", \"<\", \">=\", \">\", \"!=\". Values that are zero, negative, or non-integer return a 400.\n- (String) `name` - Wildcard matching allowed\n- (String) `status`\n- (String) `lead_source_category_id`\n- (String) `vendor` - Wildcard matching allowed\n- (String) `medium` - Wildcard matching allowed\n- (String) `message` - Wildcard matching allowed\n- (String) `description` - Wildcard matching allowed\n- (String) `start_time`\n- (String) `end_time`\n\nYou will need to apply the `==` operator (or another supported operator) to check the equality of one of\nthe filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here are\nsome examples:\n\n- `filter=name%3D%3Dexample`\n- `filter=name%3D%3DGoogle%2A` (name starts with \"Google\")\n- `filter=id%3E1000` (id > 1000)\n- `filter=id%3E%3D1000` (id >= 1000)\n- `filter=start_time%3D%3D2024-12-22T01:00:00.000Z`\n\nFor fields which allow wildcard matching, you may use the `*` wildcard character (or its encoded form\n`%2A`) for case-insensitive prefix matching on text fields. Example of a valid wildcard pattern:\n\n- `field==foo*` finds anything in `field` that begins with `foo`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n\n- `name`\n- `status`\n- `vendor`\n- `medium`\n- `start_time`\n- `end_time`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "532ceddf-dfef-4da4-80f8-c1caa1cc855f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lead_sources\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbb88c97-183b-4c9f-9e6c-15bed57e5492", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "290added-c307-433a-967f-5e10b8d565de", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e37a8a3-0637-47b7-96c0-b0e8e723705c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef852519-4d3f-4e49-8f02-6bb0ae0d1e67", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c80efa-f211-469b-8d75-4be493b1ca12", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c33ba04-2f8e-47d5-abd0-067af486c147", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc564c38-21dd-42c3-86e8-9695c593e95e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b44e412e-2af9-4460-9132-902ac88a1e08", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8789d31d-d01d-4728-a746-317da87da2e5", "name": "Create a Lead Source", "request": { "name": "Create a Lead Source", "description": { "content": "Creates a new Lead Source", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08b1f445-496f-4a0a-bbbd-297f51be3e80", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dfc3159-0afc-4a4b-929d-48036d79d4ea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fc8b0a1-61f5-4e03-846f-e085a3a19fb0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "072634db-90af-4b05-bae3-962b19bc9ac4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5f5544b-fa4e-4fe5-af99-025168ce843b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4dff33e-7132-4e83-8e98-7f4029be2889", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9938776b-e031-4e4e-a5fc-ce5e0b7c13f4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a9cf7d-473f-47c0-9bcc-944164ddce16", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb2c914-0020-4488-9b04-1cf00245c5da", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95c4f7bf-9cc2-4b26-9818-173ed65d1e3c", "name": "Retrieve a Lead Source", "request": { "name": "Retrieve a Lead Source", "description": { "content": "Retrieves a Lead Source by ID", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3759cccb-f7cc-4a1c-bab7-f1415ad289f8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51cf381e-5ffc-4e61-897d-5943ea93d1da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6b9dd9d-9467-4941-ac03-88d91843f42d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d66c8706-cea4-4757-a9fd-6f19173d5982", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "066fd70a-5d8b-472a-8760-4342a9342b37", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a362db1c-4565-45a8-a0a6-85e5db6dee19", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7ad4902-f32a-4a20-b6de-3e9aadf983fe", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36126b56-85b2-45d8-8847-65776cd22450", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df0e631-086a-408e-93df-44c8ec74ca89", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b73f39e-8ef6-457b-9ce1-eba696368d5e", "name": "Delete a Lead Source", "request": { "name": "Delete a Lead Source", "description": { "content": "Deletes a Lead Source by ID", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "39146d2b-e3a4-4d28-8a8f-ed7f29cb3347", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b51d752-f488-4787-981c-96986480acaf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2759e5b4-c39b-482c-8a8f-7ad4c89e96c2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de106961-4faf-4c04-9598-c21b29aeb75e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eaec63f-f6da-4782-b7c3-f8faadea02db", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8eb7fa9-f1fa-4374-9718-575e28270139", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c42c0a2-a949-4d13-b1a3-a3f5e209b32b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d01a7ea-9e00-43ba-b5c1-244424b7b548", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121d3c0b-cbf7-4b9e-8359-1fccc5c06e19", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da8a4f0f-8c43-4998-8928-99a80d9f3a21", "name": "Update a Lead Source", "request": { "name": "Update a Lead Source", "description": { "content": "Updates a Lead Source with only the values provided in the request", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "start_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "vendor", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58f068a7-5bee-4751-ada2-7f0fa2bfd2ef", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09b3245e-d6c7-40b4-a5fc-551ab84685b2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb8ca3c-c319-4ef8-9c97-c7dfb1a81492", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c16697a7-b9e9-4f1c-8b55-b86391554128", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "297643cb-c494-490c-b7db-0878c5cc5970", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a82aac-a91f-4925-b0ed-f002d1a670b9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f48e721a-3be4-47ac-a72f-626c75a119c0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73480cbd-eee0-4e9c-86fc-f3dc5519c124", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce6e725-cdf7-482f-84ba-26eca89e7e62", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "vendor" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of a lead source" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Google Ads\",\n \"description\": \"Paid search advertising\",\n \"vendor\": \"Google\",\n \"medium\": \"cpc\",\n \"message\": \"Spring promotion\",\n \"status\": \"ACTIVE\",\n \"lead_source_category_id\": \"string\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6becea7c-5078-41b7-abe0-6749e56db415", "name": "LeadScore", "description": { "content": "LeadScore endpoints.", "type": "text/plain" }, "item": [ { "id": "688dd7ed-ba5a-4886-a859-4230ff8e4be8", "name": "Retrieve Lead Score of a Contact", "request": { "name": "Retrieve Lead Score of a Contact", "description": { "content": "Retrieves information about the Lead Score of a Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7d6ba890-5059-4b18-9b9a-4bcb73bf0c22", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"score\": \"string\",\n \"last_updated\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2a40552-5478-44bd-b2dc-d82aeeccffd5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e75a8f9-9bc0-42e8-a4d7-5d5fd3e68ce8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62bffe62-2363-4701-834d-deb0c19ed492", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "191ae3b2-5332-40f1-860f-44e16860510d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ecfd956-9a4a-4825-ba5d-b52258d7afbf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9522323d-7e1e-4363-ab7a-02f9fa6abe70", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "644e4f8a-e07f-4532-af84-6d84d3200817", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799bd119-41a2-4173-b9a7-559bc6d59e30", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "leadScore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a58f990b-4b02-4293-a605-285e35d961b5", "name": "Locale", "description": { "content": "Locale endpoints.", "type": "text/plain" }, "item": [ { "id": "d5cb2af0-ea62-4f6b-abae-f47ff5fe0436", "name": "List Countries", "request": { "name": "List Countries", "description": { "content": "Retrieves a list of countries", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "83615570-7776-46b2-a853-55f6e62b9a90", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"countries\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7189e7f-8710-4c5a-a0da-18b50962e0e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b38cbcc-f7a7-4916-8163-4d98ad721b12", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c129af7d-931a-43d9-8350-d27bad88ba93", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1afaa48e-67ff-4b98-b71d-2b8ffffa9951", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba9b065-bd5f-4f12-8daf-5c1bebc7c56f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8691706-2391-482e-abb3-b9d1a521db53", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02df1956-7a46-4f6c-86d3-b7f184a724c2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87cb0fab-a714-4238-8f4b-fd315eaeb1ef", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f8f6126-4a8f-426a-98ae-a21bb522de0b", "name": "Get Country", "request": { "name": "Get Country", "description": { "content": "Gets a country by its code or name", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ac696a6f-9964-459c-93b2-85348e63e752", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"codes\": {\n \"alpha2\": {\n \"value\": \"\"\n },\n \"alpha3\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d74757a0-43b0-46fc-b61e-91a1614bb8ba", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4075618c-447c-4ca4-93e1-c05b65471e7f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c694d14-e337-4727-9ee4-d85af32b6d55", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ddf261-2d05-47a3-9c6b-bd95d3fe7b5b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44948842-e5e1-4588-9305-b9a400af083e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd2d53bc-b088-4732-ac20-61c596ec61af", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bae37be-0e49-4905-b419-d9646d66adff", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "130de9cd-bbe8-47fa-a343-257957358bcc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-2 alpha-2 code, alpha-3 code, or name of the country to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6002126-15f0-4ea5-bd3b-1510d4063370", "name": "List a Country's Provinces", "request": { "name": "List a Country's Provinces", "description": { "content": "Retrieves a list of provinces for a given country", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "502748d8-187d-499e-bca1-593237bbacc0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"provinces\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56b5fa7f-ed02-4023-b1c4-b375e0d18858", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e058b2dc-41be-45f1-898e-c9fda347cfa2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f2d96b-36f2-4140-9ba3-7d3128a376d7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8954c085-026a-4467-980a-f4d092e0ce4c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d03fa7b8-91f0-4969-9aa0-36371a971d8d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df9f888-397d-4d01-9671-6fc96fd867ab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0287c465-f93a-459a-8643-10762588dece", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d91f68ec-1721-472f-8786-85c3dac6f7e0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2b6d0f3-fd3f-48e7-963c-d7835d59647c", "name": "Get Province", "request": { "name": "Get Province", "description": { "content": "Get a province by its code or name", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d542e9e4-be2d-4ffc-b35b-8a1259050038", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"string\",\n \"name\": \"string\",\n \"country\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1d302d-a533-41bb-bbd5-516963910bf5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658b3751-015b-4e00-8446-b9343719abc7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b96612e-43aa-4877-bb7d-bdfe4213dcab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "082d3a49-bf7d-4313-82a3-5817d26d6128", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce938597-371b-43a2-bf42-d8bb0546ccaf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c64f4f50-059a-4446-8fcc-38928ff2bec9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "251ea823-ceaf-47dc-9916-dc6ea712c7c6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f749290f-bdd9-4b71-a029-c9a0a61f9586", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "locales", "countries", ":country_code", "provinces", ":province_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "country_code", "description": "(Required) The ISO 3166-1 alpha-2 code, alpha-3 code, or name of the country to be retrieved" }, { "disabled": false, "type": "any", "value": "string", "key": "province_code", "description": "(Required) The ISO 3166-2 code or name of the province to be retrieved" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ea45b685-03b8-4637-9ad5-ee55509fbbfb", "name": "Merchants", "description": { "content": "Merchants endpoints.", "type": "text/plain" }, "item": [ { "id": "fa9959d0-ea71-4c0e-935c-1303b0508237", "name": "List Merchant accounts", "request": { "name": "List Merchant accounts", "description": { "content": "Retrieves a list of Merchant accounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `id`\n- (String) `name`\n- (String) `type`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=id%3D%3D123`\n- `filter=name%3D%3Dabc`\n- `filter=id%3D%3D123%3Bname%3D%3Dabc`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b111945b-0537-4c06-aae9-8fc95970b1e4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_merchant_account_id\": \"string\",\n \"merchant_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "632fc83c-567f-43ee-ae24-94921c180b18", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f09d234-85e4-4d2d-824d-ccb240d89287", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671fa20a-c28f-4895-a51b-2c7883f0b128", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96b079e-8a9a-4c79-9a39-113c272401f9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7131d5e5-2ce4-4a6b-b779-917001e71749", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96469c22-ce19-4d73-8601-b5172a4b7a48", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "843d78ad-4d2f-400d-8db4-c7514b38eff0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e94d6d5f-6695-40b1-8676-32ee60e485e1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ae16fc62-8d94-4c80-ae5a-59273abafd13", "name": "Note", "description": { "content": "Note endpoints.", "type": "text/plain" }, "item": [ { "id": "786cd9fe-1512-476c-9624-bfbb5cafcc6f", "name": "Create Note Custom Field", "request": { "name": "Create Note Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f849769-f3be-4270-8088-865b854120e9", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15228ffd-1b2f-4fc0-b3b1-4b1ede2f2884", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e428f9e-6786-4157-a3b9-4310541c74db", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66657d36-3303-432b-ae4a-1d0a00aa52ab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "278505f2-99fb-4d07-89a9-f968e6f2c94c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16b5c8fe-4347-4e85-b437-2c1f53dc2964", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0c6a880-2a63-4c5b-9a2c-587c0e63434c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49b73adb-0887-4997-bdac-99756cdbd5b0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a2d05a4-148b-464b-9bbc-144efab8f8a1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f9f2bae-1dca-4ef9-b2fa-0dc7c7c4a6be", "name": "List Note Custom Field Tabs", "request": { "name": "List Note Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9bb0870d-5a8b-4627-b628-fd7e18244831", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de2b18c8-8713-4d0f-a677-c12307e61741", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1ea2840-d1c7-4808-9594-d3f1ce027530", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af69243-0202-427d-ab8e-993946c1ea2c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146cb525-328f-43c1-a769-f68813ca35d0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73dc1a94-af85-4ed5-aa29-fef5a5ffbd96", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4450d88-e039-4b7b-b027-454b863557e1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717758c2-e626-4ac0-97da-59b553945e38", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f60723-5665-4379-8e7f-5b5455dec809", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "109e2313-6818-442d-b899-4c723b52da56", "name": "Create a Note Custom Field Tab", "request": { "name": "Create a Note Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a5106401-d1ec-4142-adb2-af5551ba0312", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76010bec-936c-452d-9fd2-f8c69bd76eb6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17c06dbb-cd10-4ef9-b355-e079eea3967c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f7f612-6520-4269-82d8-8a85f53e5429", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a453f371-9d1a-4e54-9861-8228553b5d64", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb0772c-1cb8-45af-85c5-f46b182c76ad", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2694ff7-b2d3-4b23-ada5-c68cc3289f90", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab5b6f8d-4edb-478d-a8c7-9a7542e3cdd0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbbfc2f-41dd-4a89-86ad-78bd3f621590", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24de97ce-27c1-4373-8c06-4a44bb72640b", "name": "List Note Custom Field Groups", "request": { "name": "List Note Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Note record type. Optionally filter by tab_id to scope to a specific tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bd7c1de2-b1bd-4474-8744-1b852fe55b5b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1274d29f-fdad-4da9-9edc-e1233c3c69b3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc08472e-f862-485a-b048-239a4712759c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aefcfb7a-358f-4c61-9f20-d544354ea5e2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c2efd08-0527-4099-9d26-d1f7503d6dae", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff1ebb3-4b90-446f-92bb-d5ad1b492ae3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e183d79-3fa3-49ee-988a-0448900cd8a0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f62e0b3b-326c-4481-96bb-019eefeeb8ca", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a0f428-5056-4278-b15b-91b4a487d6e0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8b4b2a7-177b-4884-9c38-e368527d0692", "name": "Create a Note Custom Field Group", "request": { "name": "Create a Note Custom Field Group", "description": { "content": "Creates a new custom field group for the Note record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "73305b31-04e9-4d29-b6ca-9e66d6d9746c", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11001ace-518a-46c0-a496-dadb5409ba5c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62ad56b-2db8-400d-a858-1ac20018c0e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddd431a7-8841-4ce9-bf10-0844e4497749", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c123534b-bc47-4a0c-9c31-05cef2387f68", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96be2f4-9a07-4ec3-8723-73a1e821aaf7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07ff1ec2-579a-4918-b477-ffdc6c4ac418", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c6590a7-f86a-488e-a3c2-d232d6e00aa0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49003cf-a93a-409c-bf0c-e9846b34fa6c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7301d4e-933c-4b66-8732-15c0dc256dbd", "name": "List Notes", "request": { "name": "List Notes", "description": { "content": "Retrieves a list of Notes for a given contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply. Allowed fields and operators:\n- (String) `id` — supports `==`, `!=`, `>`, `<`, `>=`, `<=`\n- (String list) `ids` — comma-separated note ids, supports `==` only (e.g. `ids==1,2,3`)\n- (String) `title` — supports `==`. Bare value matches anywhere in the title (contains).\n Wildcard prefix match also supported (e.g. `title==Follow*`)\n- (String) `contact_id`\n- (String) `assigned_to_user_id`\n- (String) `since_time` — ISO-8601 date/time\n- (String) `until_time` — ISO-8601 date/time\n\nOperators must be URL-encoded. Common encodings:\n`==` → `%3D%3D`, `!=` → `!%3D`, `>` → `%3E`, `<` → `%3C`,\n`>=` → `%3E%3D`, `<=` → `%3C%3D`, `*` → `%2A`.\n\nMultiple filters are combined with AND using `;`.\n\nExamples:\n- `filter=contact_id%3D%3D1001`\n- `filter=id%3E5`\n- `filter=ids%3D%3D1,2,3`\n- `filter=title%3D%3DFollow%2A`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nCustom fields (when enabled) can be filtered by their field name (case-insensitive).\nA standard field above takes precedence over a custom field with the same name.\nSupported operators depend on the custom field's type:\n- Text-like fields and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `Priority%3D%3DHigh%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (including user, month, day of week): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601\n- Multi-select fields: `==` matches records that contain the given option\nExample (for a custom field named `Priority`): `filter=Priority%3D%3DHigh`\n\nNotes:\n- `id` and `ids` cannot be combined in the same request.\n- Wildcard `*` may only appear at the end of the value (prefix match).\n Leading wildcards (`*foo`, `*foo*`) are rejected for performance reasons.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "30f550cc-a379-4452-9127-47d230b593f8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53537084-f733-46aa-883d-138271f90816", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74be3d0d-d413-400e-bd75-8aa165cfa9fe", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77eeb26f-798d-4398-abe1-9070c6333a17", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d6b1d06-7e92-40c7-acce-4bad7e1e138d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b933a23-0305-43d8-be35-3b9bc809a708", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f4ba41f-faf6-404b-99af-76ca68523d2c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93fb508d-d9b5-497a-8123-c3d5dffd3659", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b64a4de-cb09-4926-91a0-7a3bd0243088", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47b1cff8-eba7-475b-808c-ffe6e8e50cca", "name": "Create a Note", "request": { "name": "Create a Note", "description": { "content": "Creates a new Note.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "082eb961-9a06-4c38-a15e-ce7900c474ca", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"text\": \"Called about the Q3 proposal\",\n \"title\": \"Sales Call\",\n \"type\": \"Call\",\n \"contact_id\": \"string\",\n \"assigned_to_user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"last_updated_by_user_id\": \"string\",\n \"pinned_at\": \"2024-02-18T16:45:00Z\",\n \"created_by_user_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfb7ae08-87ee-4727-81b7-a8647ac2bed2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f706ad-b763-49b3-9357-2e20dc11d90e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b816590-f088-4bb4-bd7f-f43b0fe56b33", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6807c986-e6ed-4c6b-bd39-4733fdd7c583", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7de4b33-6f55-4f41-99c4-0bc7eb46de4f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63fe2fc7-d70f-4151-9c1c-bca1d0347b6f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3bd04cb-7ca8-41d8-9156-d553d1f04979", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0461a541-4b2c-430f-bafe-1c2aa218cb8a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7d5210c-c33f-4c76-98d6-56e982930137", "name": "Delete a Note Custom Field", "request": { "name": "Delete a Note Custom Field", "description": { "content": "Deletes a Custom Field from the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "39b923e6-8055-42ff-9619-c064b5aed380", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6afb768a-3c78-48c3-a2f6-88c23538eaea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70a33a8e-c46c-4fa8-b730-9fb829c21b1c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6fca62-133c-4d71-a23b-1b3c8641e8ee", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4781ac-3ac2-4d3f-a92c-05f40db58f2e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41446e1e-179c-4719-a67d-9580fdce8f6b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c5a8bb0-2f11-4b94-9901-6980d0ca5170", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201db909-424c-461f-abbb-ecc09afa08e7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbfd650f-638a-4fcf-87ab-a8232a5bbeff", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "418abdf7-0646-46a9-852a-5df5cdd356b2", "name": "Update Notes Custom Field", "request": { "name": "Update Notes Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2dd1b95d-130b-4078-b18e-9ecd387803c8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5784db-db76-4216-a939-8803156416da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffe40084-91df-4a50-95fc-fe0cf71aed95", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d87d93c-8230-4d6d-8fb9-2194375c9971", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4350e529-5adc-478d-ad5a-f8b8871c13a2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8feedcab-cc6a-46fb-92ca-e4286c6f7b02", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581acc71-d342-448a-9985-9e0d95b37984", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0344d25c-cb0a-4994-8eee-71ba02988d97", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e1a4bd-c4d9-4851-9aed-9de4a5bc5041", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a8a924c-9e66-4707-bf56-398afcec5de7", "name": "Retrieve a Note Custom Field Tab", "request": { "name": "Retrieve a Note Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Note record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b3a7c953-3a7a-4865-9fb9-7d474a3ac3d0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "092d18c5-12e5-4ab7-820e-ba3516e4fdb8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62179a5b-3e35-495c-adf7-cd2a6d2c58e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc545acb-0fb6-4abb-849c-7e5822be7321", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b9536ce-17b7-4d5a-b0b4-fec9f3e45702", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e808e389-4fb1-4bfb-abec-f8b22a3e1bda", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f9613e3-39a0-43f0-b573-e2f8ba967538", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cca1d8f-8e6b-46fc-96c6-06ff5afcb61b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "681953e3-957e-431a-91d1-07bd528edfa2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "930ca34f-4960-47d1-851a-2df4f237842d", "name": "Delete a Note Custom Field Tab", "request": { "name": "Delete a Note Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "659827a4-788d-46bf-ad82-ef7e49b547c3", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c08a22f-0db8-41d5-9b5f-892f2cd5df8b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf22c536-1db2-4c38-a56c-e9b12a07d044", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc16a94c-1c13-41a3-9d79-c94d78b315a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1040c1c1-457e-4f1c-a79d-238cd115dce4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86201f9-e9cf-47da-b4f2-5f42054bca43", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7d3f505-496e-4d57-a8cc-560110cda8c3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a6ea55-128a-467c-8a8d-fd8b672097ed", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05d214d-144b-46cd-90ca-f1b1fe5b3d93", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76d1350f-fd88-4df7-9984-03bc028d266f", "name": "Update a Note Custom Field Tab", "request": { "name": "Update a Note Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49e70b2b-2ddd-4c7b-9258-6d975be201e4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c71314e-2b53-40d5-90a9-a8927a9e468f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d3f4bfe-6f4d-4510-8b23-24343c66c0a9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0938ff64-0b7b-40a7-ba73-08a58cf60129", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "822b9d79-dd8a-4da8-b970-56ef2952abeb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73b3dfd0-54f5-4d56-8704-e592c7961f04", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1ff98f-0267-4f73-85e4-3b2f78288175", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aceac476-d046-48b1-8279-da13a2480452", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f122ea4-5f98-4d4c-9438-82983e640890", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32b65146-3cea-4998-98ed-833144ddf58c", "name": "Retrieve a Note Custom Field Group", "request": { "name": "Retrieve a Note Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Note record type.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "702dd4bd-ce1b-4f37-add3-62785a5a7134", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb61fc40-17e6-49d7-9bf5-00b9ba93624e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4bb963-2584-4f80-98ce-f0e2374856c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c78bfe2-2633-463a-8cf4-0043b9631052", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb290701-1b08-48d4-b04f-915ad8ba33f4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bc0d58-04fa-43b6-a97a-ef82cb3f2d1c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b03e7299-6efa-46c1-8c80-560d895dc969", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dbc0321-09f1-428b-a946-84c5fb3d9030", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "416f5a50-a8ae-4bbc-b0ec-95dee924e9e5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e9ab0b5-2013-4abd-8bf1-9d0621d8f4d9", "name": "Delete a Note Custom Field Group", "request": { "name": "Delete a Note Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7e5c091a-1135-4e47-819c-d43050af5a96", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a68a46c-896f-4d9a-aaed-d63e4fbfbf39", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25759777-50ac-410f-8b24-720655f3e69a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6c765b-47d4-45c6-ba36-7bd7f8855a61", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41878e20-ad17-46db-a918-fcb99fb21aa6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08dec45-388b-4dcb-829e-e47175afffe5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba8e097-1469-4d19-b2ef-0cb1d6a43afb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f77da1-00ac-4716-a2ce-2dfa29001acf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46e24b4e-f3c5-40b3-a4aa-d52e396e290a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f51a8e59-a056-40d6-8ab0-a03685d3e884", "name": "Update a Note Custom Field Group", "request": { "name": "Update a Note Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f4cd975-adc2-4f4c-968d-bb3923f8dc2c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea124ef-e673-43aa-b0ac-d0ade97de07a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8735c598-95c6-4f54-a760-7a39d863f8c2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78eea4b7-8a4b-4d34-9fb9-472c5d06267b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa4260d3-d2a4-4fe5-aef3-65f8a194f166", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3faf9a-fdb2-4723-9321-8e8c5f97a5a1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c301deb8-7e5b-4cbc-a1b1-21a404256841", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5449a231-fe9f-4041-8f7a-e0823f5c36fa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5f9a30-39c3-4a40-a8b6-bec7ab812779", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30d03091-4b36-46b7-aed8-89e4a7900a7d", "name": "Retrieve a Note", "request": { "name": "Retrieve a Note", "description": { "content": "Retrieves the specified Note", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9ff262d0-76f7-463c-bd6c-3946e65be9c7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"text\": \"Called about the Q3 proposal\",\n \"title\": \"Sales Call\",\n \"type\": \"Call\",\n \"contact_id\": \"string\",\n \"assigned_to_user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"last_updated_by_user_id\": \"string\",\n \"pinned_at\": \"2024-02-18T16:45:00Z\",\n \"created_by_user_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f60708c-d033-46c8-9bc7-0d33e93dc5c7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d67d91d-9fed-4168-b4bf-d491b39cbf4f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c7d28e-11f5-41c8-94ca-5fb3edc5ee79", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d810b3d3-ec12-4846-9b6f-bb9248c77184", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26870ac7-f4ca-4628-a775-47c419573379", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2cce982-76cd-4dab-92c2-42c57bfd51c5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63ea4a58-42d3-4c40-9334-957e1fccc48c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0351e11f-9fcd-49d1-b0f0-076f57e40c2f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e76408c2-b4f7-46b1-a761-10ebda77b66e", "name": "Delete a Note", "request": { "name": "Delete a Note", "description": { "content": "Deletes the specified Note", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c1dad0d3-1672-46af-8899-f4cc236f4640", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4680fb0-4845-4c4c-acdd-574f75624c5e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ad4368d-dc8a-4061-a4e8-d67c2b951505", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed2a67dc-92f2-406b-9c4f-e80f110647be", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b9d34a-95c4-486e-8c79-9685e04874df", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9422bb0c-ea64-4dd9-b779-a5a8d17649b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "762a7c86-0ead-4dc6-b3b0-21cd7ad7cc5b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1707c890-8100-4699-9098-5ac733a0cc1c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aecbdff4-b193-49d8-b2b6-00cb4102d521", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4c16310-fd41-47a2-a848-2e4d9217b2f6", "name": "Update a Note", "request": { "name": "Update a Note", "description": { "content": "Updates a Note for a Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "type", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "is_pinned", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1ada3af4-7773-4aa9-ae67-2340c38c6ba0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"text\": \"Called about the Q3 proposal\",\n \"title\": \"Sales Call\",\n \"type\": \"Call\",\n \"contact_id\": \"string\",\n \"assigned_to_user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"last_updated_by_user_id\": \"string\",\n \"pinned_at\": \"2024-02-18T16:45:00Z\",\n \"created_by_user_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5a2ef4-46fd-4a62-bb34-b4347f32f0e3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e0e8d86-3826-4aa2-938b-05c53c89207c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bda02f7-ac4b-4c63-a409-4e9de1b01de6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507941b3-48ad-4933-8990-d2506165b143", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c30cd219-c03b-49f0-b7ef-c677cc35bf60", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd9baedb-803b-41a2-8701-8116da6af728", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cda1131-7f73-4769-b6f0-a3b04bce436a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82aea754-0f9b-4af6-8788-f080706b0784", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f0ebf83-b17b-45c9-b140-0503878e4477", "name": "List All Notes", "request": { "name": "List All Notes", "description": { "content": "Retrieves a list of all notes", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply. Allowed fields and operators:\n- (String) `id` — supports `==`, `!=`, `>`, `<`, `>=`, `<=`\n- (String list) `ids` — comma-separated note ids, supports `==` only (e.g. `ids==1,2,3`)\n- (String) `title` — supports `==`. Bare value matches anywhere in the title (contains).\n Wildcard prefix match also supported (e.g. `title==Follow*`)\n- (String) `contact_id`\n- (String) `assigned_to_user_id`\n- (String) `since_time` — ISO-8601 date/time\n- (String) `until_time` — ISO-8601 date/time\n\nOperators must be URL-encoded. Common encodings:\n`==` → `%3D%3D`, `!=` → `!%3D`, `>` → `%3E`, `<` → `%3C`,\n`>=` → `%3E%3D`, `<=` → `%3C%3D`, `*` → `%2A`.\n\nMultiple filters are combined with AND using `;`.\n\nExamples:\n- `filter=contact_id%3D%3D1001`\n- `filter=id%3E5`\n- `filter=ids%3D%3D1,2,3`\n- `filter=title%3D%3DFollow%2A`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z`\n\nCustom fields (when enabled) can be filtered by their field name (case-insensitive).\nA standard field above takes precedence over a custom field with the same name.\nSupported operators depend on the custom field's type:\n- Text-like fields and single-value choice fields with text options (dropdown, radio, state): `==` only, with optional trailing wildcard (e.g. `Priority%3D%3DHigh%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (including user, month, day of week): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601\n- Multi-select fields: `==` matches records that contain the given option\nExample (for a custom field named `Priority`): `filter=Priority%3D%3DHigh`\n\nNotes:\n- `id` and `ids` cannot be combined in the same request.\n- Wildcard `*` may only appear at the end of the value (prefix match).\n Leading wildcards (`*foo`, `*foo*`) are rejected for performance reasons.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c9227b43-82b1-42a8-a5ed-02b501f487d4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66e9278a-268e-449b-8f95-0a851e6e5f14", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25541a06-08de-4637-9cb3-82a9d4d9f589", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17d78f32-7120-4526-b1d1-aca551f66833", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3d5cbef-d6c9-4231-af38-95cc1d4f0eef", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df341c7e-6fc6-4a10-a77c-d72d6f12209a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33fe45b5-479f-46cc-8f54-f7cbc2b3677e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d645b393-9081-49c1-ade4-ae4360dfd73e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb6e60f-1253-4c9f-94b7-15fd4b27114f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9ef0253-d331-4717-8b49-c4e02cf0d21c", "name": "Retrieve Note Templates", "request": { "name": "Retrieve Note Templates", "description": { "content": "Retrieves a list of Note Templates", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Search filter to apply to results" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items by. E.g. `given_name desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a12f7cbd-351d-4b68-95e0-29ff51eee411", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"note_templates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c278bfa8-b101-45b1-899f-8fa80d0bc036", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a1feab-349f-4efe-848b-6a23bb1c38c2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7147ded2-8a71-422b-89f2-7394888001ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d5a200b-d328-4159-9353-ef56ac3b1b14", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39ca77ff-3909-41c8-836c-5f58523d3a4c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a03f42bd-4a13-4d68-8797-66c93beba638", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4742f15c-1a83-43cb-9108-f8be0f6fe328", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "048e58d4-f86e-4831-becf-f67c090e438d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f22f4665-d885-43c5-b700-23130b8e2438", "name": "Retrieve Note Model", "request": { "name": "Retrieve Note Model", "description": { "content": "Gets the custom fields for the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5fb3575b-ffa4-49a8-a924-49635368ddac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "401ac557-0e46-42e8-9297-95ca57b333e1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3742119-1afe-426a-ba5f-d6c730871e2b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99c8f133-c6db-4189-86f4-80680e1592af", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240b8b0c-5511-4ad6-a9ba-933635896751", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e241bcc-3625-4aca-b981-df73b6f07a94", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20e00a6a-03f5-4914-86c3-7bf7ff9fdf84", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e79838-e6e5-4db2-ad3a-8b63b0a4692a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b259b7e-0c44-42c6-b00b-a079103754b5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7c434df8-33b1-42db-a79d-ee1caa476f29", "name": "Opportunity", "description": { "content": "Opportunity endpoints.", "type": "text/plain" }, "item": [ { "id": "de83b11c-6b4a-4f31-af6a-7a7ab2fee8da", "name": "List Opportunities", "request": { "name": "List Opportunities", "description": { "content": "Retrieves a list of all Opportunities.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `stage_id`\n- (String) `user_id`\n- (String) `contact_id`\n- (String) `opportunity_title` — supports wildcard prefix search (e.g. `opportunity_title==Deal*`)\n- (String) `lead_source_name` — supports wildcard prefix search (e.g. `lead_source_name==Web*`)\n- (String) `affiliate_id` — exact match only (e.g. `affiliate_id==123`)\n- (String) `opportunity_id` — supports comparison operators: `==`, `>`, `<`, `>=`, `<=`\n- (String) `ids` — comma-separated list of opportunity IDs (e.g. `ids==1,2,3`), maximum 100 IDs\n- (String) `contact_phone` — matches the contact's phone. By default it is an exact match against the stored value, including any formatting characters (e.g. `contact_phone==(480) 123-4567`); it does not normalize or search across an unformatted number. Supports wildcard prefix search for partial matches (e.g. `contact_phone==480*`)\n- (String) `contact_city` — matches the contact's city; supports wildcard prefix search (e.g. `contact_city==Chand*`)\n- (String) `contact_state` — matches the contact's state; supports wildcard prefix search (e.g. `contact_state==AZ*`)\n- (String) `projected_revenue_high` — projected revenue high; supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `projected_revenue_high>=1000`)\n- (String) `projected_revenue_low` — projected revenue low; supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `projected_revenue_low<=500`)\nNote: `opportunity_id` and `ids` cannot be used together in the same request.\n\n**Custom fields:** opportunities may also be filtered by any custom field defined on the Opportunity record, referenced by its field name (e.g. `cf_priority==10`). Both indexed and non-indexed custom fields are filterable. The supported operator and value depend on the field's data type:\n- Text-like fields (Text, Text Area, Name, Email, Website, Phone, Social Security Number) and choice fields with text options (Dropdown, Radio, State) — equals (`==`) and prefix wildcard (e.g. `cf_company==Acme*`)\n- Numeric fields (Whole Number, Decimal, Currency, Percent, Year, Month, Day of Week, User) — equals and comparison (`==`, `>`, `<`, `>=`, `<=`)\n- Date and Date/Time fields — equals and comparison; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `cf_renewDate<=2026-01-01T00:00:00.000Z`). Date-only values such as `2026-01-01` are rejected\n- Yes/No fields — equals only, value `0` (No) or `1` (Yes)\n- Drilldown fields — equals only, integer value\n- Multi-select fields (List Box, User List Box) — equals only, matched as a contains search over the stored selections (e.g. `cf_tags==red`)\nA custom field that does not exist, an operator unsupported for the field's type, or a value that does not match the field's type returns `400 Bad Request`.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to opportunities items.\nOne of the following fields:\n- `next_action_time`\n- `contact_name`\n- `opportunity_title`\n- `created_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "status_id", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6013ff30-7870-4d65-8e36-9da92313f6f6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"opportunities\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22a9ca9-bc1d-4be2-adeb-a7764c6d2952", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09430c72-1e42-42f5-8b38-0b4b785a095f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35657dc-482e-432b-9260-675a54ac54f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d458ec7-a2ec-466c-9193-9a236ddc47fd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cc387a-746c-4f28-ac3f-a8ec35dc1e2c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a35aa01-30bb-4a37-9f59-e9becfb9ebae", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828014b0-f65f-4db5-b467-c21a1bb978aa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ffeeb7-d219-49e4-9905-ed3a08116421", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f60fd99c-9541-4929-bd51-746bd841d0b0", "name": "Create an Opportunity", "request": { "name": "Create an Opportunity", "description": { "content": "Creates a new opportunity as the authenticated user.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "status_id", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "edb23580-cffe-4ce4-8417-38749f5258ab", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n },\n \"job_title\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n }\n },\n \"opportunity_title\": \"New Business Deal\",\n \"stage\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"reasons\": {\n \"value\": \"\"\n }\n },\n \"id\": \"string\",\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n }\n },\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Follow up with decision maker\",\n \"opportunity_notes\": \"High-value prospect from trade show\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"last_updated_time\": \"2024-03-15T14:30:00Z\",\n \"affiliate_id\": \"string\",\n \"lead_source\": \"Web Form\",\n \"monthly_revenue\": 500,\n \"order_revenue\": 2500,\n \"objection\": \"Price\",\n \"status\": \"Active\",\n \"status_id\": \"string\",\n \"stage_entrance_time\": \"2024-03-20T10:00:00Z\",\n \"last_updated_by\": \"string\",\n \"created_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8dc6d9b-ea39-4b3c-9c2d-f95979f0884b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef4d4ac-80f6-45a0-81e3-f3ad13542983", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6fcd3fb-3fea-4e9d-a1ad-4b6490e5f2ea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e0f723d-1d0f-4aab-9ea6-8a86464d2805", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "facd32a6-69a9-4f05-a218-f1a7ca512e65", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b421b3e9-f8c4-4318-8890-e1c56e77d916", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b17bc28-c8cf-4ce6-a502-8ab06fb7554e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92a7c72d-cf28-425b-8826-59742172dfa8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5787d884-9ab9-4a6f-b914-60fd11234c35", "name": "List of Opportunity Stages", "request": { "name": "List of Opportunity Stages", "description": { "content": "Retrieves a list of Opportunity Stages.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `opportunity_stage_name` — supports wildcard prefix search (e.g. `opportunity_stage_name==Qualified*`)\n- (String) `opportunity_stage_id` — supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `opportunity_stage_id>5`)\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order stage items.\nOne of the following fields:\n- `stage_order`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "eb779ed3-4cee-4e1d-bf3b-ab14dbadf658", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9163e8ab-0c54-4dcd-b762-4220a70691bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a9fc42-889f-46e8-bb0c-66515074de09", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93a91a6-a0f2-449f-a3b5-7d3038bd6d8b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c85b98-ffb2-40bd-bbe9-4ddfe1be418f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb0319c5-5c5b-4bf4-8fff-d2e0c7a60840", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ec5c33-e2d2-4f8c-92b7-92cc4f478dec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51ade5d7-9cec-4ed3-aa88-49a40f921b35", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33db6e01-efe0-47ed-bbee-8d3623050202", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ad4428d-1edc-4c53-919b-d6af763db419", "name": "Create an Opportunity Stage", "request": { "name": "Create an Opportunity Stage", "description": { "content": "Creates a new Opportunity Stage", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9572682-757b-4f7e-a372-6596594aedc6", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Qualified\",\n \"order\": 2,\n \"target_number_days\": 14,\n \"probability\": 50,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\",\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a21082b5-128a-4448-999d-8f487b03e5b8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0de60f7-2dd7-4abd-9872-f683ff7c223d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7af9d4c-d83d-4f41-b7b1-16ce5e8de2bb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a3c8995-7759-4aff-a810-6bdd42de239d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6cb522b-f9de-42ee-8026-2d76adae1fb6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c510028-8dc1-45aa-89e9-b537814aa33a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "260b66ae-6c5c-4de2-8533-7bb4c5ed518f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c86d98a-2e16-4173-9628-36a1d06a8ae5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Won\",\n \"order\": 5,\n \"probability\": 42,\n \"target_number_days\": 10,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efb1e205-5e6d-464a-9e9e-7dfac494732f", "name": "Create an Opportunity Custom Field", "request": { "name": "Create an Opportunity Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Opportunity object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd16cdcd-b1ca-4a09-896b-9276dd143eae", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bafd162-9c62-4d6e-84d4-1cf946fd97e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2d8f465-beee-4a9b-8dca-a65874f42017", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfaf326-cb9f-4f5f-b1dc-1740ccbc92d5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88c70819-d442-45bf-9538-e4b3018f30b8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16de3f75-a5aa-4c9b-affb-af4374503b0a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4e10c52-6118-476a-82df-34c7b7398861", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8889a964-14cf-45c2-b2a2-4e243bed70f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65eec29-dafd-480c-a4af-65adec2c5df9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59180326-3494-4adf-8bd5-03855e380e31", "name": "List Opportunity Custom Field Tabs", "request": { "name": "List Opportunity Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Opportunity record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ea3ff108-c27c-49e1-870b-121240651895", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e867234e-b04c-4bb8-82e6-6657f144055f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0577d687-e306-4be1-ab35-fef578f063ac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d64fe0-a305-49d9-8dde-4fe39e636b36", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aa81bde-8dc3-4bbb-bca3-0a87fcf6bae0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef5406a-d34c-4909-8b1f-c6251296940a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f82d29-418d-43fd-b3b9-f0d6038a9329", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd909879-c1da-4355-815c-0fe2b527f7f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf55871-d2d5-4e4c-9636-194e100a1cec", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5332390b-e8ce-403d-981e-76d62ee5f7e3", "name": "Create an Opportunity Custom Field Tab", "request": { "name": "Create an Opportunity Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Opportunity record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "887069ca-b375-4cf1-b316-81a48c94a9fb", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1905ed05-693f-4fff-abe2-3835c0d9496c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3a3c4f-1dc6-419d-b1d5-512bbe48bbb4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe5f8d89-eebc-45b9-be13-ad85b76eb8c9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0c23449-175b-4668-9496-fcb1d89a3950", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed284e4-0a97-4189-a6c2-aa7326255b1c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d8abf9b-93df-4e25-a872-f5bb5731db00", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a90b3ab-8b79-4f2d-9760-eeadc54accbf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27bdf779-d56b-4e24-abe2-eb4414e0a346", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81baa508-2849-477d-9312-4ddeeac8582f", "name": "List Opportunity Custom Field Groups", "request": { "name": "List Opportunity Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Opportunity record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "27a51920-d919-4cde-9a4f-da85fbe9a493", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8593d6a3-f5a9-40a5-982b-3fee750e1af5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a35200af-7888-411f-be40-08bad19aa69d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7b81f64-9d4f-404c-9e85-45f14dfa2620", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4616265-4e2d-40c1-b097-99ab798ff3b7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d8160c-61e2-4fec-b382-24dd21753aa0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ca2c2a0-ef57-49fa-9493-a4a5e5859c96", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f60325c-ed6b-405d-9782-ace156a988ab", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13e27198-ba6e-44a1-b7fd-a4750c3a39f6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30d21fca-3177-4f3c-bfaa-47aafb897ef2", "name": "Create an Opportunity Custom Field Group", "request": { "name": "Create an Opportunity Custom Field Group", "description": { "content": "Creates a new custom field group for the Opportunity record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eccda336-3159-4ecf-a5b6-a95024e39850", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c1e2ab1-78d0-40e0-b388-1179dc48a721", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a7831d-47e4-4a0c-abfe-b57cf1052fb0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c479f321-5f40-4cb2-bc7d-55aef7a421bb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fe28b9a-8f11-4388-8cb3-38443b2b8b2f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf8838bf-6949-4509-bf61-399d09b24bd8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80247f39-c8f1-47fe-b65f-aa36cb5e947b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb822a6-03ed-407d-8c9e-7fda7b616d95", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fadc12eb-ae03-406f-834a-fc2b5be7cb63", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "052db128-bd4a-402d-a0e9-5abf8bd0c340", "name": "Retrieve a Opportunity", "request": { "name": "Retrieve a Opportunity", "description": { "content": "Retrieves the specified Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "status_id", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2404daa2-a8a7-4535-bade-0324f76fec5d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n },\n \"job_title\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n }\n },\n \"opportunity_title\": \"New Business Deal\",\n \"stage\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"reasons\": {\n \"value\": \"\"\n }\n },\n \"id\": \"string\",\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n }\n },\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Follow up with decision maker\",\n \"opportunity_notes\": \"High-value prospect from trade show\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"last_updated_time\": \"2024-03-15T14:30:00Z\",\n \"affiliate_id\": \"string\",\n \"lead_source\": \"Web Form\",\n \"monthly_revenue\": 500,\n \"order_revenue\": 2500,\n \"objection\": \"Price\",\n \"status\": \"Active\",\n \"status_id\": \"string\",\n \"stage_entrance_time\": \"2024-03-20T10:00:00Z\",\n \"last_updated_by\": \"string\",\n \"created_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1611a66-871c-4c00-8412-470954da1fbc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507e4a2c-ecf5-4705-a109-d9e9e90464ad", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3d00977-d3ef-441e-a63b-251eb8344a82", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae639063-8028-47f9-97da-4295d716ab1c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efa2494b-1ea9-4f13-bf2a-04f7d6227575", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8f7631f-2462-4852-a28f-f7380bc3e7a0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1533ac2-09e0-408e-ad37-4577091aa235", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342cc4f5-eef8-4a5c-b394-f531295af2a5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e23f146-aa51-43fd-857c-9b0a6cbda5be", "name": "Delete an Opportunity", "request": { "name": "Delete an Opportunity", "description": { "content": "Deletes the specified Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1de9a301-e342-4298-9b92-ce97cc61570e", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c51a4dcb-0e23-4dcd-8ad0-6981cd10ec2f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a11400ce-6be5-466b-a5b5-136f01dfdbf1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e403834-dec8-416a-bc5b-28e7d2462de3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61593907-d04c-4296-be1b-bd7144bcc7a3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d310208b-fded-46d7-84b7-014ee9f281b4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c36437-1249-4819-ac9d-e1836056179c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13495a15-1401-4021-b26f-bfe762024013", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8badfbe8-0e77-4a4b-a079-dae1d844f028", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e57eafc7-f89f-4999-be39-b3b4cd9f8c8c", "name": "Update an opportunity", "request": { "name": "Update an opportunity", "description": { "content": "Updates specified values of a given opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "estimated_close_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "user_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "status_id", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2a9a991-b2c4-4866-be36-9402c71b68af", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n },\n \"job_title\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n }\n },\n \"opportunity_title\": \"New Business Deal\",\n \"stage\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"reasons\": {\n \"value\": \"\"\n }\n },\n \"id\": \"string\",\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n }\n },\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Follow up with decision maker\",\n \"opportunity_notes\": \"High-value prospect from trade show\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"last_updated_time\": \"2024-03-15T14:30:00Z\",\n \"affiliate_id\": \"string\",\n \"lead_source\": \"Web Form\",\n \"monthly_revenue\": 500,\n \"order_revenue\": 2500,\n \"objection\": \"Price\",\n \"status\": \"Active\",\n \"status_id\": \"string\",\n \"stage_entrance_time\": \"2024-03-20T10:00:00Z\",\n \"last_updated_by\": \"string\",\n \"created_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "950b51be-c169-4260-baf8-2be621d00ceb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faae12eb-1732-4b2a-9478-7d4040b094a6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26e53866-93ce-47d2-b294-dc2c8ca8b7bc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "285d7d3b-bf61-4348-889f-c4cfa9119977", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e736b3ac-f22b-4582-a214-283b8b584166", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8922e2af-724b-4ceb-a97f-7d4f985ea7c7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "427d0310-922c-4362-93a5-f7e20ddbee1b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e6fcee-d012-42c9-9aa1-427d468c47ad", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "projected_revenue_high" }, { "key": "update_mask", "value": "custom_fields" }, { "key": "fields", "value": "monthly_revenue" }, { "key": "fields", "value": "order_revenue" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ece0f6c-8cbf-4d0b-ac95-f18a1e6536ba", "name": "Retrieve an Opportunity Stage", "request": { "name": "Retrieve an Opportunity Stage", "description": { "content": "Retrieves the specified Opportunity Stage", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "29eb3f2e-28cf-45e5-a705-23169d215e06", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Qualified\",\n \"order\": 2,\n \"target_number_days\": 14,\n \"probability\": 50,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\",\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15c00802-bd7d-4d4a-8c6b-44f3763800bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed5672e-14a2-4995-b545-d4c91ce94aff", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6425639-e392-4094-89d6-11a360065fbc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdbcf960-6af9-47c1-a52a-646db7b1cabd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86d3a657-0ca3-4b61-aee2-002ab4c4ac48", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392e7f8a-3c25-41de-b080-d85b3a978d71", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41b61b5c-04f3-4333-96ab-9f429a7ab697", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "267a3aed-67c0-4dda-bd2e-550b2f39e405", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6eed3042-5206-4380-a168-744450dc2b09", "name": "Delete an Opportunity Stage", "request": { "name": "Delete an Opportunity Stage", "description": { "content": "Deletes the specified Opportunity Stage", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b5324d24-bcf8-4378-8d5c-017e0132a95f", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02735d8d-b111-469e-a1c9-ed0f2f92f7b1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e390261-38fe-4170-8fa3-46936add2003", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4114fe04-489f-4672-886d-52b3236bda8a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6ab255e-26ba-4293-a592-f0c2fd979249", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09eda057-0f04-40a0-98ca-f639d3c86dfd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fabca9cd-975f-4b54-a7e6-c50b50e32200", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "083ea652-b2ee-48e3-9e55-5bba769b969e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29481536-1960-4957-9ed2-2c6cfe19e193", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a8d5434-6133-4a4b-91cb-5d724f2e21a1", "name": "Update an Opportunity Stage", "request": { "name": "Update an Opportunity Stage", "description": { "content": "Updates specified values of a given Opportunity Stage", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "checklist_items", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 1521,\n \"probability\": 2,\n \"target_number_days\": 8657,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89e22b8c-2a31-4b64-ae5e-4c95cade9d01", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Qualified\",\n \"order\": 2,\n \"target_number_days\": 14,\n \"probability\": 50,\n \"created_time\": \"2024-01-10T08:00:00Z\",\n \"updated_time\": \"2024-03-15T10:30:00Z\",\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d8c56d4-add3-4d73-bcab-69b44053a42d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00eabd3a-bc66-45e5-8f00-2c67bbe73643", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b648d6c6-be0f-461d-a6e4-3bcf5256bf1b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25328f04-9abe-4bbc-9acb-29f7de1eaf8d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ab5e1c9-798e-4378-b875-8e6e6da00c20", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f020ac1-80f8-47e4-adf0-a09c83618754", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb569ad-75fd-4faa-b8ef-887a2fa65803", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba83e38f-24fd-4ee9-954b-ca5012d88488", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "probability" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2596,\n \"probability\": 2,\n \"target_number_days\": 2195,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0276ac91-4100-4d5e-a313-f59985a9154f", "name": "Delete an Opportunity Custom Field", "request": { "name": "Delete an Opportunity Custom Field", "description": { "content": "Deletes a Custom Field from Opportunity.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "d482cd11-444f-4e92-a227-0c13ebdfec1b", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c761c471-ee31-4283-ae17-305db276c388", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f6e7afa-0278-4ecc-9622-365fbdf464b3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89dd2e13-b288-4673-9ac3-6da125e38f93", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3638ee-8022-4931-bf17-b22ba90315ed", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bcb9fc3-68b2-4dd1-99c7-105395fbf1d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc5e51c-c002-4b6f-b1ee-279d8895839e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd112568-abeb-477b-99e1-9ebc20ae4287", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d99e3c27-acf5-45a1-8b9b-89f4d65f9ab7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e92a17a5-a96f-448d-b61e-509aecd0a431", "name": "Update a Opportunity's Custom Field", "request": { "name": "Update a Opportunity's Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Opportunity object.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e8bfb0d3-72ca-4c86-bb3b-9177a80e04b8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313d5d2b-9a53-4b28-b44b-4278bdc4e62a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a475381-b99d-4c67-bbd0-62f3243118fd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3bc6db1-896b-4fce-b9c6-10a8d6ff0c42", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "498997df-ded6-41a7-8c69-462020eec8ba", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b2205d-9cca-402b-94c2-7a37c1870cc7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba4c6ef-9241-4a42-84c9-89ff5028e313", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb121e6f-6b8d-4564-b9fb-a09d6c75d446", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4846cafd-fdc8-4a39-83a9-a706677a1385", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee0fcf47-d31e-4e60-bade-b3c8210864c1", "name": "Retrieve an Opportunity Custom Field Tab", "request": { "name": "Retrieve an Opportunity Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Opportunity record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b5657631-d6ba-4799-ae76-6f61a6ceedef", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6ded112-40e6-498c-92f2-2675b0899948", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64af39dd-fafb-46dc-a462-301e12ce2edf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84fd9bb1-6176-4980-86b8-c683643942c5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96f361f0-d664-46e9-84cb-2f7380e5901f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1ac9b6a-ce86-4642-9add-3ea3b4781600", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a1576f-d453-426b-a65a-5a3b0b4f40f7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbc80420-d952-4672-bd3c-2fc998393d02", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c5c3e74-6ca2-4c8f-8199-b715d88a7b30", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "704db3a1-7c2c-4caf-b225-3852a2b0489b", "name": "Delete an Opportunity Custom Field Tab", "request": { "name": "Delete an Opportunity Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "25afe88d-c85d-4a31-87ed-0bbc9f95c406", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0784c920-7443-4993-916c-3ec157c2f6f8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a59f2cf2-32dd-4220-8456-d399eef2d91f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "442f2b32-9bfa-47fd-8072-9083c284834f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539d1a03-9f46-4e93-b750-d5c8c9838b5b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f04ecae-e827-4948-928b-748706e1c405", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13743956-e8d8-43b3-9947-737ac40e0fee", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73183206-bc83-4ad2-82eb-fffbb42330bb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2254b60-40aa-45f5-9b26-d16a3bf9187b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90a70cd9-89f8-4743-89cf-c688227b51d6", "name": "Update an Opportunity Custom Field Tab", "request": { "name": "Update an Opportunity Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2981991f-bd32-4e2b-8c00-a1222767079d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49cf89e-89ae-468a-a975-be0350f2af6f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8564a30-0cf7-47ad-abfb-1c23d1d18df6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d9499f7-bbba-431a-b179-2cdda35e84ca", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387c4470-6d88-471b-9fc9-f9aad63c34ee", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cce43f3-8a6c-40e4-a334-fff86d00b750", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe96af0-0862-43de-8058-438444a9117d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e71df12-27d8-44aa-8fac-0a9f9213eda3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81711bb7-9ff8-45ff-9954-4c0aa4245097", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d25b271-4c5f-4b76-8802-17a6f23d18e7", "name": "Retrieve an Opportunity Custom Field Group", "request": { "name": "Retrieve an Opportunity Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Opportunity record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "48b18df7-194c-4c57-aaa8-05b8dcdfb489", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcbfa4eb-5033-46c0-b008-0bf1c2adf7fe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50f16e9f-af27-4b80-98fa-a7e0920678a7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fecbf0e0-a584-4606-8c03-44b22da8230f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b48add-19f5-4061-8465-d8c83723bbab", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9510a44-6985-4acc-b7c8-ae2cf072ce0e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eaa8200-8246-4f9f-9810-fb8bf5db21c2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad168cc2-42db-4072-af19-c6698b71e691", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6575ce22-34b0-44fa-90f9-55ecfff6821c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4026de39-1792-4559-a7e5-a82de02be1fd", "name": "Delete an Opportunity Custom Field Group", "request": { "name": "Delete an Opportunity Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "527ce15f-a9bb-4a1d-9221-2777003a3e5d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a50f0b58-9b48-4923-9f48-3696c451bf4e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833bd144-0069-414c-b8c9-d355a594ff1b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e51248-3c76-4148-a7a2-e025962404f1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "115c57e4-ee7c-4605-892d-8d6343d6a97f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f152d8bf-6e81-4cc4-ae50-6c29eef481c7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40002a72-e895-4325-abad-98f669fc6425", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5cfd04e-ea1f-42d1-aad1-9b2c4b723bb4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc844090-a152-4e1c-bf99-551a73d2c64f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef2dae75-8d65-4137-ab07-83921fe3e167", "name": "Update an Opportunity Custom Field Group", "request": { "name": "Update an Opportunity Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b1084733-6275-44b5-9709-d84fff6bd250", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19da78e8-2bbf-42a2-b71a-5bb53330eb6f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257f49b7-10ae-4122-8981-25b6b41ceeb4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f00246e-979d-4ae4-943a-949ff686849f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f5d79f-6787-437b-a5fb-37bcaec0c4d2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb29db4c-5aec-4b01-926c-61f00131aeba", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2f4e7f7-55bc-410e-bc2f-38944b0eea23", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d71d476-f55a-419e-b0d9-1d69f480ae83", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c56cb067-b85e-4dfd-b995-791c515ced58", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f51899f-5fb8-4712-86ed-db0f3f5a04fe", "name": "List Opportunity Stage Moves", "request": { "name": "List Opportunity Stage Moves", "description": { "content": "Returns a paginated list of historical stage-move records.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply. Allowed fields:\n- (Id) `opportunity_id` — supports `==`\n- (Id) `user_id` — supports `==`\n\nSeparate multiple filters with semicolons: `opportunity_id==7;user_id==1`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Field and direction to order results.\nSupported fields: `move_date`, `id`\nDirections: `asc` | `desc`\nExample: `move_date desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ce86641a-4a0b-47c1-b38f-04e29e1daae5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stage_moves\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d0467ea-a3b2-4f25-ab12-af50b6a82f7d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb33f6f0-cf78-4516-91ea-81140fcea354", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c7e53aa-50cc-4b53-b459-f81179fbe949", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf746ad7-35d9-4fe5-ab61-82275dc5737d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8583d7ac-9d3e-4578-a9cb-6cc21fb59b5d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9857bd1b-b8ec-4cb7-986f-892ebf01a036", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7449bd5-1e87-48fa-abf9-a2ec9d2c3dc5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cc46898-78d3-4879-946b-0187c60baa5c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad8232ff-34dd-45c2-ac40-58c93e9aa3c2", "name": "Retrieve an Opportunity Stage Move", "request": { "name": "Retrieve an Opportunity Stage Move", "description": { "content": "Retrieves a single historical record of an opportunity being moved from one pipeline stage to another.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "aceaedbc-55f9-465a-894f-bd84fba74ec9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"opportunity_id\": \"string\",\n \"move_time\": \"2024-03-15T10:30:00.000+0000\",\n \"move_from_stage_id\": \"string\",\n \"move_to_stage_id\": \"string\",\n \"prev_stage_move_time\": \"2024-02-10T08:00:00.000+0000\",\n \"user_id\": \"string\",\n \"created_by\": \"string\",\n \"create_time\": \"2024-03-15T10:30:00.000+0000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c477ebf-278d-49f4-b73e-30e44c3f6496", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07266cc-7d95-4ac1-bd90-fd607ba52320", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd24cc0c-6e5f-47f9-9ceb-46da0ef2d0ed", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd8f2be-cfbc-4af1-9bc1-92bf1637e766", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "295cb898-89dc-4d90-9558-380a552e2989", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef1453e-61f6-4667-a833-3d97925f0fc8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59435309-7e41-403e-bbc5-6c92987ad44a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa92528-a2cd-456a-adcf-5e08a84834c8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stageMoves", ":stage_move_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_move_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8898869-ebfa-417d-ab8f-851a97d84178", "name": "Retrieve Opportunity Custom Field Model", "request": { "name": "Retrieve Opportunity Custom Field Model", "description": { "content": "Get the custom fields for the Opportunity object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8da3dbcf-ffe3-45fb-b946-9a39ddbdcd84", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c64b2d62-4cc2-4404-91b2-b9a61a798d9e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c4d064-cb8d-42f5-a1ad-173f03fe68d9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34d291bf-ac82-484c-9d76-fbd19eb351a9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5d596c1-0748-4df6-be5a-f665d6a59f3c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f122dbe-2f0e-4735-ab24-7cf4ccfbf780", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c11c229c-eda6-4993-a7f7-dcf1a096e272", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb362fba-785a-4a3b-aac5-2b19edfafcd1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "544a03e1-c424-4fa2-9049-86377b2857bd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ef1bd847-d4bb-4ebc-94ee-f6a2af873ed3", "name": "Order Total Discounts", "description": { "content": "Order Total Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "5cb244d1-08fd-4650-bbb4-c53cd99d99d3", "name": "List all Order Total Discounts", "request": { "name": "List all Order Total Discounts", "description": { "content": "Retrieves a list of Order Total Discounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (Boolean) `apply_to_commissions`\n- (DiscountStrategy) `discount_strategy`: GROSS or NET\n- (DiscountType) `discount_type`: AMOUNT or PERCENT\n- (Double) `discount_value`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=apply_to_commissions%3D%3Dtrue`\n- `filter=discount_strategy%3D%3DGROSS`\n- `filter=discount_type%3D%3DAMOUNT`\n- `filter=discount_value%3D%3D10.0`\n- `filter=discount_type%3D%3DAMOUNT%3Bdiscount_strategy%3D%3DNET`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `apply_to_commissions`\n- `discount_strategy`\n- `discount_type`\n- `discount_value`\n- `id`\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d564d842-647e-4fa0-94cc-c5cdf1b00ca5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"discounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce4034b2-eda1-45d6-8c2c-95dd07dc09da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5211c440-3926-409b-95fd-ef5bcd534f33", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2877902-caff-4f3a-9e91-dfd21a357570", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47b7057e-b348-45b7-b629-ec1e5f44835d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501d6ded-b6fd-4e56-8a1c-ae4c4d422c74", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2554cb3-cf51-484a-8a13-021f32220ca0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cff3580d-800a-4b18-b095-8566e5b4941f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd34329b-4096-4f55-8ccd-a1d8df7b325b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d3cc1b7-00c4-4874-99a6-6d8883f01878", "name": "Create an Order Total Discount", "request": { "name": "Create an Order Total Discount", "description": { "content": "Creates an Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f7051383-9717-4a58-bbc2-da54fb78cbcd", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b5ea923-f20a-4eb8-99b5-5dae74f4e89f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee5bddb-ac9d-4b8b-9ea4-0b5c21dcef05", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95a7bfa8-d8a2-4fc1-b36c-6cbe96fb59be", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe930a6-d39e-4b2e-bad6-a2d79bf372da", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614e0ab4-e6ff-4fbd-82de-96ec3beb24fc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e642856a-e2f3-4fe0-98de-bb9dde29f312", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96ace500-797d-4aec-92b8-0d36eda24761", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58b0633-8744-4b5c-821c-3bb601a9b227", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55836ee8-1e6b-4a2f-b273-21d8f834817c", "name": "Create an Order Total Discount Criteria", "request": { "name": "Create an Order Total Discount Criteria", "description": { "content": "Creates an Order Total Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "95347a7f-e091-4643-b8e8-5acdeef4d04f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"criteria_id\": \"string\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e6f6c3d-42ce-4f21-895a-19d471d79fbe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "446029a6-5804-462a-9a10-331d81dea2b5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "099ca5f3-c145-495d-9074-dd9bfa9320fc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f06eba7d-1cfa-4f43-ac9e-870867e83558", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b67855e-d439-4115-a6b9-799b22f4d5c3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "928e822a-aadc-4fd3-842b-7bf78668444c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0818ffc6-eefa-4fbc-b919-c68819047661", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c8336de-7bf9-45c4-a2e6-346d7b129a31", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ec363ca-9b8d-4c7f-b6a5-aac81dda5521", "name": "Retrieve an Order Total Discount", "request": { "name": "Retrieve an Order Total Discount", "description": { "content": "Retrieves an Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1c8b19a9-b71c-4bf8-a4ae-6c8c527a8b32", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aae5328-a64b-493b-a1da-3391b34971a3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9bb7fca-8ce4-4468-849e-9d1c397526f0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25d49466-b8c1-4527-a04e-3624405dc996", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc3e7d35-9014-46e7-8db6-9937778b3289", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69acc64-3de2-472c-b358-b8292d4cc147", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dab3252-3e43-4751-bdce-1cc2fe558138", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539f1017-1812-4959-b6e3-4970ee30d497", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c127b3c6-a3e6-4a45-b9a3-8dedb6f35db0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23df1472-0e8a-40c2-a862-1b1b2049adfe", "name": "Delete an Order Total Discount", "request": { "name": "Delete an Order Total Discount", "description": { "content": "Deletes a specified Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "209a23d2-6de7-4977-9b55-6e2f4ba98c7a", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb7d3650-056c-4f2f-bb96-70b1828c3a8f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dca9dfec-25ad-40d8-bd86-8a17dea4bb6e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00b4b31c-e841-46bb-a583-e1bc0ccd1607", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f339df-1964-4523-bd76-2506b982d02c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae8dfd93-283f-4545-8534-80d8f56feffd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5152ee-d250-4888-aaaa-a52d454853f2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca02a81-079d-4b95-b90c-7a0a2b34d46c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f7f1859-655d-42ea-b3b2-69508f39400b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e3a45c1-cddf-4988-a694-ff4e39fb5a34", "name": "Update an Order Total Discount", "request": { "name": "Update an Order Total Discount", "description": { "content": "Updates an Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "discount_value", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "efccccdc-95f0-4fd1-aba5-24a7d34dcc43", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce1237d2-4cf2-4178-af76-f926563e5ea6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55adcd77-63ea-45d2-96cd-9fb244038dac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acafec33-9852-4263-9379-e67a00196dd5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d6811a-f81e-4a99-a6aa-a79b727fea54", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d099f00a-aa0d-4efa-82e5-136cc58e6025", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3113af-b1ad-4823-95c9-3a2ece130e4a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76efd220-85fd-447f-b1b4-054a81fa6e92", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a2faf88-9c9c-4102-ac28-61c0869bdf1f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c267f919-44f4-4327-917d-b5468b4c0fe9", "name": "Delete an Order Total Discount Criteria", "request": { "name": "Delete an Order Total Discount Criteria", "description": { "content": "Deletes a specified Order Total Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e24c66c0-5f7a-4c45-8a34-98dfe83ea66f", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "608ff7e9-6c3a-41e7-bb74-e4dd0e86f5ae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff98454a-4870-4c4f-b8ea-e2d9a0c68fd7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de7de092-028b-41b0-a049-a3ae780dc8c5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a788be5-24de-47a7-a080-cf5a72faa57f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707ee97d-9204-4125-b4ab-c2e0a8fb8ea5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d85926-120b-4222-8658-142773c557b1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ae3bb5-9dc7-42e6-b581-1d5c02743aa6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53a1b134-3c2f-4272-a0db-f0cae541c962", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "15a7adf8-a0bb-46dd-b1f3-2795de7406ee", "name": "Orders", "description": { "content": "Orders endpoints.", "type": "text/plain" }, "item": [ { "id": "4fc2015b-d0ff-429a-9f54-22bf82eef825", "name": "List orders", "request": { "name": "List orders", "description": { "content": "Retrieves a list of orders", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `id` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (List[String]) `ids`\n- (String) `product_id`\n- (String) `contact_id`\n- (String) `invoice_id`\n- (String) `invoice_xid`\n- (Boolean) `paid`\n- (String) `created_since_time`\n- (String) `created_until_time`\n- (String) `modified_since_time`\n- (String) `modified_until_time`\n- (String) `title` - Wildcard matching allowed\n- (String) `order_type` (Allowed values: `ONLINE`, `OFFLINE`)\n- (String) `shipping_locality`\n- (String) `shipping_region_code`\n- (String) `shipping_postal_code`\n- (String) `shipping_country_code`\n\nCustom fields can be filtered by their field_name (case-insensitive, as returned\nby GET /v2/orders/model). A standard field above takes precedence over a custom\nfield with the same name. The supported operators depend on the custom field's type:\n- Text-like fields (text, text area, name, email, phone, website, social security\n number) and single-value choice fields with text options (dropdown, radio,\n state): `==` only, with optional trailing wildcard (e.g. `_OrderTitle0%3D%3DValue%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (whole number, decimal, currency, percent, year, month, day of\n week, user): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601 (same as `created_since_time`/`created_until_time`)\n- Multi-select fields: `==` matches records that contain the given option\nCustom field filtering on non-indexed fields is supported but may be slower.\n\nYou will need to apply the `==` operator (or other supported operators), to check the equality\nof one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above,\nhere are some examples:\n- `filter=product_id%3D%3D123`\n- `filter=id%3C123`\n- `filter=ids%3D%3D1,10,4,24`\n- `filter=invoice_xid%3D%3Df411a79c-9a92-4960-91d9-656f910a25e8`\n- `filter=product_id%3D%3D123%3Bcontact_id%3D%3D567`\n- `filter=shipping_locality%3D%3DPhoenix`\n- `filter=shipping_region_code%3D%3DIN-MH`\n- `filter=shipping_postal_code%3D%3D85001`\n- `filter=shipping_country_code%3D%3DIND`\n\nCustom field examples (for custom fields with field_name `_OrderTitle0` and `_OrderValue1`):\n- `filter=_OrderTitle0%3D%3DTest` (custom field exact match)\n- `filter=_OrderTitle0%3D%3DTest%2A` (custom field prefix wildcard)\n- `filter=_OrderValue1%3E100` (custom field numeric comparison)\n- `filter=product_id%3D%3D123%3B_OrderStatus0%3D%3DActive` (combined standard + custom field filter)\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `order_time`\n- `modification_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ed4e4e12-ef12-414a-9906-edfb438b4c79", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"orders\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c37196a-046e-470b-8d96-1455bbd6a7b4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb8486c-5508-4d2d-882b-e2e7df0cfccc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b277891b-4d82-4f58-9caa-7d15709e7b0c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "752d9a5f-98d7-409c-81e0-c64d277342ab", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cec6a66-5520-4107-85c7-1a19a40f6df5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2832910f-15d6-46ff-a848-ec3981193a7f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d29a363-4759-4121-9e5e-2feb8a07a2d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a90ec8d-f2bf-44e9-a6be-7c7785e69747", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "862bed9f-4b94-4c8b-a8ca-13b155d02b2a", "name": "Create an Order", "request": { "name": "Create an Order", "description": { "content": "Creates a one time Order with Order items", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9f2671d1-d103-460d-8e5d-5be5f9692f04", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3507058c-0ad0-476c-a5e7-51383f5e105c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54995a8a-fbaf-4768-a8e9-64e31545c74e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225f4e3b-ad3c-4e59-91d3-74c5b6e169cb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53c4b826-b153-4675-8388-974ea34421a7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04ac94fe-a354-42c8-a7d9-50f4ec7ebd47", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ca3fb88-be6c-412c-a20f-f4727a2b364a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "694505b7-17a0-4b5e-9b0d-011de8aab7a6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adec3475-7b8d-4c31-9919-bea9a5da627c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_title\": \"Online Purchase\",\n \"order_type\": \"ONLINE\",\n \"notes\": \"Rush delivery requested\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promo_codes\": [\n \"SUMMER20\",\n \"FREESHIP\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef4d4612-b9f4-4413-b89c-891b0edea55e", "name": "Detach a File from an Order Invoice", "request": { "name": "Detach a File from an Order Invoice", "description": { "content": "Detaches a File from an Order Invoice", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da474d94-d3ed-4aa1-a91a-ec664b53f3ab", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcd4ae52-e721-4eae-998f-611c849a4d6b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9baa517c-d8f9-4d2c-984b-ad35e0e066c8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb6fc18a-22ae-4dd2-b421-474dbc2e36f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da27244a-71e6-4b10-930a-2ef6c1d23771", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03312497-e8fa-4095-972c-1e4b853f7548", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f46b872a-4ecb-498b-9d93-acfde76495ea", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4431bf8e-9172-4958-878c-90d9770ad0f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f053b1c-ec07-40ac-ac56-155a469aa4d4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:detachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91593573-73e1-4d56-803f-9e3aa94b2923", "name": "Attach a File to an Order Invoice", "request": { "name": "Attach a File to an Order Invoice", "description": { "content": "Attaches an uploaded File to an Order Invoice", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9036a095-66b8-4147-9191-dd5e5392b1c2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f038c6f2-b090-4541-81b5-aa8d650b6a9d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e58e5330-809e-4a77-b99c-7916b25d2b07", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76605eef-2930-49c1-9979-c9fe0afe5b66", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb25350-c609-47f8-b3b0-1cfbb26bd818", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c1b48b-8a5d-405a-a89f-1493a4933125", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c8a4674-e9a4-4819-a392-e5fad8f3185b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "505ea6f7-5a8b-4a89-8bf3-0c40bdce0db2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f053af-033a-4b0e-838a-01bdaacc3896", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:attachFile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3915dab-5a42-442b-9dcc-83a692fb140c", "name": "Apply Taxes on an Order", "request": { "name": "Apply Taxes on an Order", "description": { "content": "Calculate taxes for a single Order for a given order id", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "b551f87b-a24f-46a8-95e5-7d63b2654ef9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff64c167-fb7f-49d4-81e4-832f4e2c892f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b902fd53-caaa-47f7-ab2a-e4e677e9a5c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a01c484-0b37-4111-8322-62e4d356e843", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8283b66-9c95-4c62-abad-6e9d406913eb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b81375b8-7785-4a72-b132-29e086273204", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beab7063-5125-492f-86a5-934db09cf075", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba17170b-202d-41fd-af7b-2fd3e310683c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6893f7a-53cf-497c-bf76-9bd99999a802", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "{{order_id}}:applyTax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfb0c9fd-6305-41df-bc55-c0df9a5496ef", "name": "Retrieve Order Payments", "request": { "name": "Retrieve Order Payments", "description": { "content": "Retrieves a list of payments made against a given order, including historical or external payments of cash or credit card", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `invoice_id`\n- (String) `payment_id`\n- (String) `amount`\n- (String) `pay_status`\n- (Boolean) `skip_commission`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\n word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=payment_id%3D%3D123`\n- `filter=pay_status%3D%3DAPPROVED`\n- `filter=invoice_id%3D%3D456%3Bskip_commission=true`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `invoice_id`\n- `payment_id`\n- `amount`\n- `pay_time`\n- `pay_status`\n- `skip_commission`\n- `last_updated_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0173803c-38a3-4e5c-87d5-daed7502a810", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invoice_order_payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0663ba50-81af-435e-b98a-b242ddc8e875", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d41519dc-fd1b-4f5d-9f66-8b202743e358", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47f2e876-177e-4083-8006-784fbbeb9949", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef09eac4-b68b-47a2-a59b-850c9f6a7a15", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29ac8044-9a04-4f4d-afcd-c6a3cf825931", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2042cc4b-809e-4c90-9e70-ff77edd26938", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b6fe1cc-9086-4f98-b8da-59629741b4c4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e68724a8-4518-41c5-8432-d1933aece0c1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2f2e5d8-c288-4e58-85b8-f8d6992c2ab7", "name": "Create a Payment", "request": { "name": "Create a Payment", "description": { "content": "Creates a payment record. Alternatively, adds a record of historical or external payment of cash or credit card", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d3b31a96-d7d1-4a1b-8852-0f502807669f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"invoice_id\": \"string\",\n \"payment_amount\": 99.99,\n \"payment_status_message\": \"APPROVED\",\n \"transaction_id\": \"TXN-789\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90e9aa8c-3198-4481-aa8c-15fbf0fb3441", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba4f562-176a-48c3-acbe-dfd80d58cb1e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ccc007-a4b6-4a2c-a6d5-1ef9e4abf2ba", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df309643-bbf6-483a-afbb-6d4f97bb553d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbe52e3b-4f59-4a13-9cc3-88c3e3180db4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cadefed-a738-463a-83d2-6eb748a2a934", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "034523c2-85af-4a22-8ccc-a10ccd7ead1e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2b5a18a-4026-4478-bbd0-18e04a2b009d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply_to_commissions\": true,\n \"payment_amount\": 8896.872002183094,\n \"notes\": \"string\",\n \"payment_method_id\": \"string\",\n \"payment_method_type\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccba1ae9-6c8e-4922-aacc-25e70d8e3557", "name": "Create an Order Item", "request": { "name": "Create an Order Item", "description": { "content": "Creates an order item on an existing order", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ff3e5f94-90bc-469d-967d-a2d69da5ab0f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget with warranty\",\n \"notes\": \"Gift wrap requested\",\n \"quantity\": 2,\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"special\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"special_item_id\": {\n \"value\": \"\"\n },\n \"discount_method\": {\n \"value\": \"\"\n }\n },\n \"product\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"sku\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"shippable\": {\n \"value\": \"\"\n },\n \"taxable\": {\n \"value\": \"\"\n }\n },\n \"subscription_id\": \"string\",\n \"item_type\": \"PRODUCT\",\n \"cost_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"price_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"subscription_plan\": {\n \"id\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"active\": {\n \"value\": \"\"\n },\n \"subscription_plan_name\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "677a2e46-9823-4257-be8e-e89753f51d9e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fdc0212-b0cb-43f4-823a-bcd7e7ff5537", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "823ea49c-10d5-45e5-b623-c2ad32971bfb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffac1a43-5a12-4062-adcd-844a930fa213", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee6979ee-a408-4686-a8b7-e719338fa0c5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa1f6668-28ae-4d03-877a-c4329e187fbe", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b9f5498-b4ee-42c5-9c46-92f091c88802", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed326ea-774e-4de8-9742-ade57de0249b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": 2,\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"notes\": \"Gift wrap\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly subscription plan\",\n \"item_type\": \"PRODUCT\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e064233-2d3d-4f55-bd5f-65f753870593", "name": "Apply Commission to an Order Item", "request": { "name": "Apply Commission to an Order Item", "description": { "content": "Applies commission to an order item on an existing order.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58b43510-31d7-4d18-b1b5-183d5a51e386", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget with warranty\",\n \"notes\": \"Gift wrap requested\",\n \"quantity\": 2,\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"special\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"special_item_id\": {\n \"value\": \"\"\n },\n \"discount_method\": {\n \"value\": \"\"\n }\n },\n \"product\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"sku\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"shippable\": {\n \"value\": \"\"\n },\n \"taxable\": {\n \"value\": \"\"\n }\n },\n \"subscription_id\": \"string\",\n \"item_type\": \"PRODUCT\",\n \"cost_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"price_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"subscription_plan\": {\n \"id\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"active\": {\n \"value\": \"\"\n },\n \"subscription_plan_name\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab535a7-9596-4f84-988e-389aeaf9d03a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "379b5835-84b7-4364-b927-60f448172d49", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e6a9b0-894c-49ab-9788-5264cd2a0415", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e606fe2d-6e39-400d-866a-093d737f0be6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffafcd96-9125-4119-93d9-8da990d0813a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17d250f7-81db-4173-b103-4d35de762189", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a773c9d1-77f3-40d9-b552-353afc632d1c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b239cb-6169-4485-8d84-83a6c9682268", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", "{{order_item_id}}:applyCommission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"affiliate_id\": \"string\",\n \"payout_type\": \"UPFRONT\",\n \"pay_percent\": 10,\n \"commission_amount\": 50,\n \"description\": \"Q1 Sales Commission\",\n \"commission_date\": \"2024-05-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d6b56d2-9d41-4b33-aea0-1073675af286", "name": "Create an Order Custom Field", "request": { "name": "Create an Order Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Order object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b96a39f6-277a-4476-b0c6-24ba9ccf39c6", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "850299c3-5467-4eb9-a202-238fb495a5ba", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9111acd-5f09-456f-b80f-be7d1dac7859", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17bc980-e43c-4fa7-88a2-63c1059df09f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5fb2a1e-d16a-4141-b9bb-77753bf4010d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59fa5d0b-d733-4fe3-b4f9-26d270179194", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fb2a5a8-d1b6-485a-a23a-ce34eb4aefd9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe143912-8a79-47df-98f9-e27354a7b872", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "344c0b3f-9153-459e-9a44-ada35e9c9449", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59d3aa2e-4290-46ff-9785-7fa2c905235a", "name": "List Order Custom Field Tabs", "request": { "name": "List Order Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Order record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9775a3ce-180f-44a5-a74e-176122c08a96", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cb922fe-be3c-4f36-aaf0-30d06b6549ff", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c9fb5f-1318-418b-8c96-ffd2824d21c7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dd96665-0492-45ea-bb58-5c6881dc621e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb0a216-4c0c-4633-8047-73a1f84d7f4b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c8871a-e65f-47b4-b127-5dea67bc1ba1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e025c349-eff6-4e20-a035-b76de95d9fae", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a88db1b-cab2-41c4-b264-7079489c43ce", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d1a425-e2d5-48a2-b0b9-fe1580c1a8e8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d602b0e-e4a2-4e90-a55e-2477beae66e9", "name": "Create an Order Custom Field Tab", "request": { "name": "Create an Order Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Order record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4f1e3c5-da16-4367-aa5b-d7881acad18f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1caf5fc-5d4e-40e1-aa50-94fa67356a9c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cef00fb-3f71-4236-ac90-b9200e6d193e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0926fa50-9ad4-4a63-842d-a4b192c37ec7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4287a629-dacc-4bdc-ab10-3b927b0d506e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fccf9b-7c95-45a5-8baa-15b379daab69", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dbda76c-a2d4-46ad-adf7-109affc47ece", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0624fa-573c-49de-af02-66f9c33fe73f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92736cb-96f6-441f-8e03-5479f3cd3d1f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e782cc79-26f0-49e5-a90c-3f6c4c2d6e32", "name": "List Order Custom Field Groups", "request": { "name": "List Order Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Order record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9d7baaf5-09dd-43aa-a836-1982074b29bd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2ac6ef-5862-44ad-b878-25e2967d6025", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f89c0f0-5966-4127-9e4e-f5c5448f3f3f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ec4e10-bd25-484a-b012-8eae799f617a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a475c6ce-90ca-4f66-99f9-6d71dbeced70", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c27108e0-fceb-4e88-87de-c17dbfef3e18", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5327104c-7255-4746-ab4e-f24cda247c16", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba369647-ab36-46c7-9838-2ef6c0ebd047", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a265c993-711a-4dc6-a7a7-fd10cf5f34e3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "717bd1f2-c3f4-4de8-a186-bc0750cab07e", "name": "Create an Order Custom Field Group", "request": { "name": "Create an Order Custom Field Group", "description": { "content": "Creates a new custom field group for the Order record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e50143ec-b3cd-40ed-80e2-e44411abfb20", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "801a5664-59c3-4c93-beae-ffb067dac2ae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e182f7-f593-4562-98c5-d11a574c62ef", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f167881-4d39-4190-83d3-f0acc0d59670", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0472333c-cc2f-430c-9557-9700da946432", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30340642-94e1-4138-b7f6-876555dbdcd9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3bad799-673e-404e-8813-c85c1d775fe6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "947bc812-bb9a-40ec-a99d-c1781d259e3a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34927cc3-3ba2-40ff-a983-28c62b06cc92", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc8e58e1-a008-4bd7-bc9d-4a2e51d4ce11", "name": "Retrieve an Order", "request": { "name": "Retrieve an Order", "description": { "content": "Retrieves a single Order for a given order id", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "049d2a7a-d901-4efc-9102-28506f640975", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb78954-90e4-4788-88d1-1d2d4bee5e8f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956b8aab-e5f6-481d-94b0-ed879d95d926", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac6136ed-3c9a-429e-9c1e-8a9d8d819da5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8cc30b0-2c78-4107-9827-b37840595fb4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83cc04cf-5c03-4418-b212-407adc95f886", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a78fb99a-542a-4e96-9f04-7dd817387a3e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6c1681c-232f-4cad-9a74-b1b8a0ab9e7c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed33175-d65e-49e5-808a-2ecedce54779", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f80563ca-74f8-4b6d-bf1e-8fb9076697c4", "name": "Delete an Order", "request": { "name": "Delete an Order", "description": { "content": "Deletes an Order
\nNote: The Order must not have any transactions recorded to be available for deletion.\n", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "478adde6-dbcf-483c-bfb3-1a7ef6326e92", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b4d1674-6b52-44c4-bf6e-f63d2a4bd6b1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66209aa1-09c3-4ef8-9462-5d305a301703", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c355538-1a86-4c5f-9599-e69297e3b92f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acbf363c-f8f7-4285-8c07-93809830a926", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89cf797b-a81a-4a1b-a7da-49c5edb67586", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7069d1b7-91f4-4ce2-ae3e-f6173a16677f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385dbae3-1bad-4957-af11-305a4b13d344", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "087c73bc-64da-470f-ae32-f055a996f9f4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd1611ec-c53c-4057-9623-e04e9c51c330", "name": "Update an Order", "request": { "name": "Update an Order", "description": { "content": "Updates an Order", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "invoice_number", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74bb4b17-01ea-4afe-bdfe-224f8fea08f2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31cd9f21-e3fc-49e2-979d-97df73b2f4c8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca6b4ec6-1015-4a56-a02e-5273ee6f05f1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d715c83-7051-46d3-a7ab-dac61483b640", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f860287-25c1-4a0d-aa6b-a3f38a755333", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b722535-311b-449c-8094-bc4d1aebfdbc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93b0c8c-4270-4353-9e6e-bca1cd9cf33b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e843069-3a1f-49d8-aa16-f3e9bf9d0c47", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "becefb64-d288-4af5-88cd-4c6028418708", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "order_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Rush delivery\",\n \"terms\": \"Net 30\",\n \"title\": \"Monthly subscription invoice\",\n \"contact_id\": \"string\",\n \"order_title\": \"Online Purchase\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"order_type\": \"ONLINE\",\n \"promo_codes\": [\n \"SUMMER20\"\n ],\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"middle_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"is_invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"payment_plan\": {\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"days_between_payments\": {\n \"value\": \"\"\n }\n },\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"invoice_number\": \"string\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16571356-e551-4906-8499-8ecc39ed84cc", "name": "Update a Payment", "request": { "name": "Update a Payment", "description": { "content": "Updates a payment record with external source information and status", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "external_status_value", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "external_update_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49044549-adf3-4aee-b393-b05f2182ab88", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"amount\": 10000,\n \"note\": \"Monthly payment\",\n \"invoice_id\": \"string\",\n \"payment_id\": \"string\",\n \"pay_time\": \"2024-05-21T23:00:00Z\",\n \"pay_status\": \"APPROVED\",\n \"last_updated_time\": \"2024-05-21T23:00:00Z\",\n \"skip_commission\": false,\n \"refund_invoice_payment_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3232f68-2f49-4810-821b-a3faa2b01d59", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b4aad6-0a65-4418-ae50-e259eaa922da", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb861e3-6302-4525-a2d0-14246d07029d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3810531c-4845-4081-ac6f-fcbc97925be1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9eb3a40-0ddd-4140-ae29-57e081816abb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1e795d4-6167-48ab-97f5-b6dcd2d8d8b2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5315b5b5-0e87-4691-acb1-7006c0415304", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4018720-3c18-4774-8896-947f1fc76517", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 9865.731611875082\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "906b28b5-b5df-42bb-9c95-958b4aab09dc", "name": "Retrieve an Order Item", "request": { "name": "Retrieve an Order Item", "description": { "content": "Retrieves a single order item from an existing order", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "23c9b724-6c0e-4316-a7f8-dab278c881a8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget with warranty\",\n \"notes\": \"Gift wrap requested\",\n \"quantity\": 2,\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"special\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"special_item_id\": {\n \"value\": \"\"\n },\n \"discount_method\": {\n \"value\": \"\"\n }\n },\n \"product\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"sku\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"shippable\": {\n \"value\": \"\"\n },\n \"taxable\": {\n \"value\": \"\"\n }\n },\n \"subscription_id\": \"string\",\n \"item_type\": \"PRODUCT\",\n \"cost_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"price_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"subscription_plan\": {\n \"id\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"active\": {\n \"value\": \"\"\n },\n \"subscription_plan_name\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b309dd6d-2aea-47bd-bdfa-7587d3c1d264", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f04bec06-68df-4ab2-9055-d59f3b38ee63", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ce5cbc-d58e-480c-9ceb-02750bb723ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132dfd10-ac0b-4397-97d2-e3af1c048d96", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a5651c-5c01-44b1-8e76-aac9d8711d43", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79e1539-9762-4023-9056-0d6010358d84", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d95359-b6e2-496f-8910-2876be1fb6c9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31ab4225-cbab-42da-895b-69bb9f209ef5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b22d8eb1-f4ba-48ef-94ec-137e4313eab7", "name": "Delete an Order Item", "request": { "name": "Delete an Order Item", "description": { "content": "Deletes an order item on an existing order", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a8ff6adb-f49b-42ed-b5e2-2cacc9b8a963", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4974df0-446d-4f6a-a354-cd0a77265f81", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f084bea0-e0d1-46a8-b92c-0ec748574311", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21bf942a-ec67-46ce-a1a6-1b7ec0d38a28", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6503ca37-d6a1-47e1-8153-5d296226113c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f790844-eb94-4815-814f-2bb5c3bfa69f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7166dfef-5549-4eee-8cbf-6ff23be86e6f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a621fee1-2aa4-4fdb-91bc-506561a94f79", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4732cfc0-afff-454a-8d89-3ae5e7fd947d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18f6cd37-d34b-4a21-a467-0a9a90412fdf", "name": "Update an Order Item", "request": { "name": "Update an Order Item", "description": { "content": "Updates an Order Item", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "subscription_plan_description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bbfda3df-c713-4f06-8fd5-3c2d32a68c04", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget with warranty\",\n \"notes\": \"Gift wrap requested\",\n \"quantity\": 2,\n \"discount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"special\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"special_item_id\": {\n \"value\": \"\"\n },\n \"discount_method\": {\n \"value\": \"\"\n }\n },\n \"product\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"sku\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"shippable\": {\n \"value\": \"\"\n },\n \"taxable\": {\n \"value\": \"\"\n }\n },\n \"subscription_id\": \"string\",\n \"item_type\": \"PRODUCT\",\n \"cost_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"price_per_unit\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"subscription_plan\": {\n \"id\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n },\n \"active\": {\n \"value\": \"\"\n },\n \"subscription_plan_name\": {\n \"value\": \"\"\n },\n \"cycle_type\": {\n \"value\": \"\"\n },\n \"total_cycles\": {\n \"value\": \"\"\n },\n \"plan_price\": {\n \"value\": \"\"\n },\n \"display_order_index\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "363d3cb9-a389-4d8a-8d36-da7a713bd1f6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32a4155d-dfbb-43b9-93d3-eebc280a27f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f6e250b-20e7-4e5a-a4ce-d169e329caa1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b605cc-f2f9-4d2c-bf5e-5810b53d317d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e5284db-5b55-4282-b624-b5f5099d56a2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb003d3f-cee9-4a3d-a55b-d4d44c602171", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9ff43c3-bc09-4302-8b39-5345d61ae1e5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34de94e9-7b33-4e76-959e-347f88ed81c7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "subscription_plan_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "order_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"description\": \"High-quality widget\",\n \"quantity\": 2,\n \"notes\": \"Gift wrap requested\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"subscription_plan_description\": \"Monthly billing\",\n \"price_per_unit\": 29.99,\n \"cost_per_unit\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab74c5ba-00ca-42b5-b771-832faf972f58", "name": "Delete an Order Custom Field", "request": { "name": "Delete an Order Custom Field", "description": { "content": "Deletes a Custom Field from the Order object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "54039cb5-3cb6-4508-8b68-44d5db98cc88", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9e0402b-1e9a-4e4a-803f-6778a87913ef", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8335151-feee-49a6-86d8-8eaf0659c07f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827a1f6c-24a5-4d6f-82c9-bc0b4b885ead", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "271fddfe-3dc4-4d84-b844-b7507ad34920", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb42133-600c-45a1-a874-aa130ac36378", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0bd7b64-532d-42b4-9baa-c098e42e240c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce2e9d58-6739-43e2-b370-b8b96cd5c369", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15bc5e6c-bcaf-452c-b934-0cafd9c98e67", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e9a500e-b56e-4036-b52a-153c9207de1e", "name": "Update an Order Custom Field", "request": { "name": "Update an Order Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Order object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d1f8fa8-bc0e-433e-9270-e000baf24a58", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec2a2cfc-0137-481e-b30a-096677d0fca0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eaf3aa9-5b08-48f1-972d-82071292bda1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e65e24-7625-4e49-9ebb-488138e8d721", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41c9ca35-404e-45b9-85fa-603255f6d360", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4f29453-446a-436b-922b-31e0ec9b50b4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "126ecc6a-71d9-44c6-af95-3d7695dffbbe", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d97bfc82-bc01-4db0-82ef-173a2dd7945f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0681d8fa-1418-460d-b1c3-fb9d4f304f7f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8b0f57f-ce8d-4c24-be4f-1d5a93fd3372", "name": "Retrieve an Order Custom Field Tab", "request": { "name": "Retrieve an Order Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Order record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ff2c2f43-805d-4229-b859-dd9695d54cde", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6c01fce-ea96-4adf-8948-5c957fe653f3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9944f66c-adbf-4266-88ec-abd15b1f8f9a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515ab69d-6cb0-40ca-a089-1872ba046d7f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "354adf5c-13fb-4869-ad38-e89a6014dd3f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43e6f469-1a9c-436d-83a2-0dc63187c000", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a325aee1-88fd-4519-9087-ee3869f7d84b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70590dc6-1d27-4cac-8f65-84419cf26526", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02e80c9d-4960-4e62-b910-bcbd369b3977", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b340f4a-1af0-4f48-b578-ce546d18311e", "name": "Delete an Order Custom Field Tab", "request": { "name": "Delete an Order Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7b2943c6-2fc4-445d-a7a7-ec764c4d6940", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "540bc58c-a070-4fec-af20-5c4539e70ecd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e923077a-cf07-4fa1-b15a-85b1600f1e5a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f17392-479d-4748-ae65-cfc1b9824617", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2374b9d-0170-49f4-a619-7d40484bad32", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47c2b73-9283-4283-93e7-b7775b07829f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e358e19c-a685-4253-afda-e62181773d7c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "588e5e75-48c1-409d-859d-8c93800b4078", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51e923d-8935-4d09-95cb-a43579771777", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11cfb50b-81b4-4275-8cfb-fade7468f1ba", "name": "Update an Order Custom Field Tab", "request": { "name": "Update an Order Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f902fe7-71fa-4806-b958-31c5db5928bc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13615f1e-a246-45d5-9a6b-e270eaa3e3c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4c56cce-c59b-46fd-b6fb-3934142f9122", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "821c88ec-dfd6-43a6-8f5b-a909d66111bf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e83b5bc6-511f-4092-8876-5cc196724ee5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ca98471-bc3f-47ce-aee5-d75b3ac650cb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a5ad46b-04d5-417c-bcd6-8409a78375b1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb7cd31-6f70-4cb9-9cc0-61eedd889c67", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d75acf1-583d-4933-af94-d355f241718a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa66640c-0d3b-4c85-a736-af3f1248a95a", "name": "Retrieve an Order Custom Field Group", "request": { "name": "Retrieve an Order Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Order record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "46da42a2-735d-44eb-8c51-c1c6b55236f7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a40bf2d0-cac9-44ee-9c41-331adbe1ac10", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de9fe590-4476-41e1-9311-3e687aefdb8c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38aa340c-8a66-48c4-8ade-1f197a751b36", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abe95039-6849-4525-a4f8-955edac09626", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f80445d-91db-4f62-be12-54469a92efca", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a38a8a-49fc-4481-8145-9d32801ac06d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ae3a24-6286-4e61-9000-08d11bfea5ef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea8a55ac-563b-4b83-811f-246cf0e9f87e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6107d2d-bf32-4209-81c4-34a6a865c047", "name": "Delete an Order Custom Field Group", "request": { "name": "Delete an Order Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ee2c6de7-d8a3-4834-9298-b341f8d87e7f", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1a5fce6-e6cc-4b95-aefe-7fdc30e36eea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e8428a8-1ca6-4e4b-ac20-9877e6091a1b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0bcc566-1961-44fb-b268-584d01c63b79", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9856da45-1679-4062-9620-1dce0d6349df", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d426bb7-b23e-4b9b-be43-b8d03ed66c05", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3d13977-16ea-4b15-a1db-c5ddd7de0903", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e81cbede-4352-427c-8970-05ef7d657752", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a4a6f7-c71c-47c7-bf7e-caeeca04d92e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "167093cc-6067-4d9e-9e12-7df45bcbc4aa", "name": "Update an Order Custom Field Group", "request": { "name": "Update an Order Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3e926c9b-0166-4217-8e4d-82b7c19a25c0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d473ba19-427e-4b70-bd61-dee53b43e3e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5ea4ed4-486b-498e-864f-8f0339cd18fa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ee6062-3450-43a4-bd0c-5b9807a87832", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7aaf87-d9ad-4129-94b2-e96fe6b96363", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "397e26b0-4a38-4529-ab6e-00cc34ca3d32", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48510634-a252-4278-a720-5e781449ed1b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da62ccdd-2668-47e7-aee0-f4166cab37a8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a46b733c-fcdc-46d6-b71f-ac3063c2e5db", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e99e116-a019-45e8-a3ab-228afc6d0953", "name": "Retrieve Order Custom Field Model", "request": { "name": "Retrieve Order Custom Field Model", "description": { "content": "Gets the custom fields for the Order object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "612fbb68-8cf8-47b9-a8e0-f38f42cb492f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8e469ce-c6f0-4e3a-9243-7a7d14dcd3bc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "259702bd-8c3d-4688-9d83-4273b34cfe59", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74d8cd2-6c0d-4a49-86f1-bfbbbbf5a3c3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2768117-a5f2-4658-af6f-fba6e26b329b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "756cc614-2e27-49a7-b060-5c61dda8512a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6ec4417-3148-462e-b088-6e54d56ac260", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392d859f-aaa1-45c2-9bb6-6ccc26dcb977", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce982f6f-9f65-4983-b6a1-f207973e0cde", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fa0c9c04-9a6c-43a5-9216-f24575957e13", "name": "Payment Method Configs", "description": { "content": "Payment Method Configs endpoints.", "type": "text/plain" }, "item": [ { "id": "6de6f7f8-6b3c-480e-b7cd-bcdf234f4192", "name": "Create Payment Method Configuration", "request": { "name": "Create Payment Method Configuration", "description": { "content": "Creates configuration details for rendering payment method components", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90be8c57-d060-4957-84f7-64e974353e84", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_key\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3696dd9d-669a-483f-8f68-fe14589849ca", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b9d1fa6-6ba8-4280-8acf-f1219f64e2e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197901d5-e060-4628-bfb1-24604025ca03", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71e96089-1dbf-4245-8b98-726ae1bf69da", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9a68eb-790f-4b94-923d-3f25a6688ffa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cc41f18-a54c-4576-8c81-26ab657ddcc0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47618465-3d7d-4b04-8cf7-24d84acc8e2e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c98bad-6d91-4bc6-9dbc-c2a476efaba2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethodConfigs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "aaca7c72-2612-4354-b130-a1f3b5a657f0", "name": "Payment Methods", "description": { "content": "Payment Methods endpoints.", "type": "text/plain" }, "item": [ { "id": "c246d5c5-bf8c-4832-adc0-558411a7e932", "name": "Deactivate a Contact Payment Method", "request": { "name": "Deactivate a Contact Payment Method", "description": { "content": "Deactivate the specified payment method", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "cf117ebb-d5a0-4e97-a8b5-9b5857398010", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a7f32f5-9965-4b95-99fc-f63e963ff242", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "784a2ada-79d3-48d7-9614-f50448dabf0b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35b7f384-d1b8-4701-9de0-5147a017b3bc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1593f6e9-a9e2-4795-8c97-89302726017b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a71998c8-ee60-49f9-aa9c-eb63c7435ec3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "377a892a-a851-44bb-941a-9390a55254cf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06b688b-0a37-4a9c-91a8-b575f6c7e634", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cc90a0b-6058-4286-89bd-35fd73bfbcbc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", "{{payment_method_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "982707c6-80be-4367-96ae-7c28b732e6d3", "name": "List of Payment Methods", "request": { "name": "List of Payment Methods", "description": { "content": "Retrieves a list of Payment Methods", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `payment_method_id`\n- (String) `credit_card_id`\n- (String) `contact_id`\n- (String) `merchant_account_id`\n- (String) `since_time`\n- (String) `until_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n- `filter=payment_method_id%3D%3D123`\n- `filter=contact_id%3D%3D123%3Bmerchant_account_id%3D%3D567`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `payment_method_id`\n- `created_time`\n- `contact_id`\n- `merchant_account_id`\n\nOne of the following directions:\n- `desc`\n- `asc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9bc14681-23c9-436e-a137-be58fd7b44dc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d720cf5-ce07-4579-8d6d-7fe9f8f4d898", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1647d76-ca05-4355-bbcc-d5115d16775a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "852b0fbc-d1d5-468b-ba14-e1f56ff20b86", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f26cdd88-848b-4c6d-9835-de53b8d5c0a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f798d1c3-7846-4e13-be78-173fd5d4c763", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4d13c2-a494-4c4a-8b68-ae09c629a3c6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c583372-45cb-418d-a81e-2dd3399a0ba0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70344d6b-60ed-4f61-82b6-c5003e3221a4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b342e3ce-d49a-46c0-b5ac-45d8ab8f512f", "name": "List of Contact Payment Methods", "request": { "name": "List of Contact Payment Methods", "description": { "content": "Retrieves a list of Contact Payment Methods", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `merchant_account_id`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n- `filter=merchant_account_id%3D%3D123`\n\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `created_time`\n\nOne of the following directions:\n- `desc`\n- `asc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "929daf1b-4007-473b-bfcd-1a13e7569959", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"records\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c3244c6-9177-4fa7-b7ad-8067cf14f387", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a3745c3-5d35-4436-9717-0325da263dd0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "360b7db4-3153-4e69-aae2-ce3eab585a16", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae04bffb-8817-4155-8833-120d36f371d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb23118-8fd1-4ea9-ae47-176e1fb54684", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc6b4ad-7f6d-4672-99e5-49d6cd769535", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54f72593-0886-401e-a688-2b076993012a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cf4a717-a1e7-43f0-9d6a-45adb040e701", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9f2ef4a-6cc2-40b2-8b62-1bcb31da8522", "name": "Delete a Contact Payment Method", "request": { "name": "Delete a Contact Payment Method", "description": { "content": "Deletes the specified payment method", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ad8da928-69c6-47a2-afec-91f0422bd520", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87982ea9-9269-4e4e-bfaf-c6fbb53e0d16", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c7cabd-7a35-411b-9519-e507c1e532a8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67cfda02-c6f4-417b-99e8-2339945fed4d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da5ea17-30f9-4b90-a1a4-e8be8fd9dde0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34595a91-793c-4ea0-a64a-f3e5a05ae0a8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9791aba-7ff1-42e8-93cc-aa1d4169fc0e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bddd7d13-4d48-4a15-950d-f3c0db033d07", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7d2b59a-0d6c-4121-8c84-822396092b13", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "paymentMethods", ":payment_method_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) ID of the contact to which the payment method belongs." }, { "disabled": false, "type": "any", "value": "string", "key": "payment_method_id", "description": "(Required) ID of the payment method to be deleted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0a7f235e-3f90-49f2-8804-ecbdeed96d72", "name": "Product Categories", "description": { "content": "Product Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "e84d332d-ba9a-4941-bae3-6b7f3d452486", "name": "List all Product Categories", "request": { "name": "List all Product Categories", "description": { "content": "Retrieves a list of Product Categories", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `product_id`\n- (String) `name` - Wildcard matching allowed\n- (Number) `product_category_id` - supports comparison operators: `==`,`!=`, `>`, `<`, `>=`, `<=`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n\nFor the filters listed above, here are some examples:\n- `filter=product_id%3D%3D29`\n- `filter=name%3D%3DTestSearch`\n- `filter=name%3D%3DElec*` (starts with \"Elec\")\n- `filter=product_category_id>5` (category ID greater than 5)\n- `filter=product_category_id>=10` (category ID greater than or equal to 10)\n- `filter=product_category_id%3D%3D42` (category ID equals 42)\n- `filter=name%3D%3DElec*%3Bproduct_category_id>5` (multiple filters combined)\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "65cd210e-adc0-407a-b36d-47ea627b3426", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"product_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b02930-b783-45e0-80a8-0c030b4b37fd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22fc60c4-e6b3-4419-8c55-8a945de2ba40", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f9ab4e-8e72-4fcc-8b64-716f3fec2cdd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d32570-97ed-4490-b481-e6e79352119d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca646e56-0f44-49bd-bdcc-1a8b2ef554a2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db8e55a-b1e3-418a-a628-ae012e48f6aa", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c63c48a-b3a8-4435-bb13-55cef6fd5281", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a25e53c-2b0c-45fd-9578-8659456fb89e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76d36e81-2877-41a3-ad32-b6e0b92ef4c8", "name": "Create a Product Category", "request": { "name": "Create a Product Category", "description": { "content": "Creates a new Product Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "29a66610-29ac-4a32-adb2-25f5c1e52ad0", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57bb758c-d73b-4ebc-98fa-928864579976", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69a9f70-0fb8-46ed-87da-12c5dbfc98a7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e817f2e4-d694-4826-a26f-91930df85b0f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2696442e-4243-4255-a4c1-e2853ae3013a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46141601-c06f-4a21-ae22-374c2bbd6319", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbaf8ae0-d19f-4ec7-988e-db49b54bbfe6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb14d27f-533e-4e96-8a54-e84e91a0ee09", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe34c80d-46b4-49a0-9741-0e428f93f522", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bde0ab64-997f-4ceb-8cb2-4c8e6d78d36c", "name": "Assign Products to a Product Category", "request": { "name": "Assign Products to a Product Category", "description": { "content": "Updates the list of products assigned to a Product Category. **Note:** The full list of product IDs that should remain assigned must be provided; any IDs omitted are removed automatically.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17d6d089-e151-401a-abdc-ded4d1cba673", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ea6f337-10f1-48ff-a2d7-8f8f88d0ea90", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7fd82fc-9a13-423c-9a8b-7a3f99c222e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f73dc0-db04-467a-b7e7-7ba1426cf516", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3507d4e9-e428-4b1c-961e-b46bb453e28b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e37679d-d11d-4be6-988f-047978e119b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8885336-2eef-4475-bb47-edb7390251a7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b294fb-e382-44f3-9fc2-61862f1867b6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2570cef-a7f8-404c-ada1-cc5051ea8d1e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "{{category_id}}:assignProducts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bba7a2e-53cb-465c-9011-eadc93613286", "name": "Create the product category image file", "request": { "name": "Create the product category image file", "description": { "content": "Creates the product category image file and uploads it to the specified product category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) File to upload" } ] } }, "response": [ { "id": "60cba15d-a2c9-4539-af47-8bd1ef06803f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbea7ff0-80ab-47e2-b266-4e2943b4c61c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb9ba5b9-fb59-41c3-80f7-cc30c71e81b7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4443b5e-fce4-4d55-b758-955726a009f2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422941e7-d397-4711-ade7-33ba7fac6ddc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47f0f26-74f5-4032-b2a1-36d245443c4c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e01aa8c-ad08-4a78-8786-3819d34ab101", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7319dd-d9f7-4065-b51c-ef57c1f00dd8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9562bd29-17ac-4512-9fbb-b26633176660", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "462eab72-b7c5-477a-a759-8c5fd245c58a", "name": "Delete the image from a product category", "request": { "name": "Delete the image from a product category", "description": { "content": "Deletes the image from the specified product category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "fe35e839-2719-4a03-92e0-a6a6122d8055", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6d28089-7844-42bf-ac0e-59378627eafc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb362db-29f1-49b6-bdc1-38b1b7713fdb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "260808a3-87d9-499b-bc8d-9715ab3acd4e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15c0a17c-e877-4ff4-9e62-a864a2682026", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb14d7a-f232-4112-ac6b-b9c9ac95bcaa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcdcc1d8-3ad7-40c8-b6d5-9016e98c57f5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a416787-7084-4a16-9119-04df79bef87f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48af82e9-873a-43fb-b650-89b64dd07edc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58aa495e-01c1-42db-a8a7-d0c7d2294491", "name": "Get a Product Category", "request": { "name": "Get a Product Category", "description": { "content": "Gets a single Product Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e9ff4e62-9886-44a6-843c-d803baff9012", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18275b07-cea7-48d0-a7ff-fae7ca0c6452", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f27a882-5353-48dc-af19-bee1839267af", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3aa8de1-ac55-4ca8-ad25-b38b91cd64e3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1712b950-2aa7-4eeb-bac2-e7d54e41d081", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d76b27-4475-4cfa-88ad-e0e787de5b9d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8434096-7313-49b7-b4ff-eceb162788f2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd8c79da-2915-4c3e-b6b8-156e3ae41b52", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f763d4e8-1b33-465b-96d0-a6025784471d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "726644d8-5c03-4d21-b993-c323586ba0bb", "name": "Delete a Product Category", "request": { "name": "Delete a Product Category", "description": { "content": "Deletes the specified Product Category, its sub-categories, and removes products from it", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f5e45269-cef5-426f-bbb0-a25142b08af3", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9408f1f7-e3aa-4c31-a6de-2da26df817c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5991261-5347-4711-85e6-56ae03937a6b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc524bf3-cbf1-4217-9a27-48ccd74d661d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3befde5e-5507-454c-b9af-d78f46420d8c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "984088a2-198c-4548-988d-e378e26a8d19", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b63c48-d70f-498c-ad43-891cdd152d82", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257da00a-1585-48ae-a767-7620bc3ecfc4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de495124-696b-4991-ab26-f85286b53392", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed4da760-1d77-4c48-869e-a6cbd4610689", "name": "Update a Product Category", "request": { "name": "Update a Product Category", "description": { "content": "Updates a single Product Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "parent_category_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "38604690-62c0-4532-baf4-7dd693fb706a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3835749c-a7a8-4761-aba7-edca6aecf460", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5eae52e-730a-45b1-8de7-b827afa00675", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5af6ce6-b066-4d8c-9917-1e27f1355119", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92b175f7-a08c-460d-b3b1-7da1baee0fb1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7fa2c5-3ff2-48e8-a22d-7aa149f79bbe", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "534a98c0-a446-442b-b592-a12fa31d665f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c652c8e2-32eb-4ddb-b9ef-bfc09a4f0834", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402e0039-0882-40be-b81a-a302dbbf670d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "776e3e02-4527-4b50-a776-6edf1da3c3f5", "name": "List Assigned Products to Categories", "request": { "name": "List Assigned Products to Categories", "description": { "content": "Retrieves a list of Products assigned to Product Categories", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (List[String]) `product_ids`\n- (List[String]) `product_category_ids`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `product_category_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0049cbfb-598c-4385-a9e8-ff780b9531e9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assigned_product_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623c4e5b-558f-472f-97fa-e9a39ceca836", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34a9d824-4128-44be-bd45-753886b02487", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e7d2d93-f0da-4ba9-b060-e0b9e6f317df", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e034330a-b43e-4d14-9612-e63ebd1414b6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ef9c42-a8c9-4204-bee6-7b1dca58069e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90e8614-c2fd-407f-a30b-69d737908eae", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43a2eadb-719e-4ca8-a960-d5cc41e8776d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f7ba8a-3bda-42b7-b07d-d835ac6f7cf9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", "assignedProducts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6af2b380-7947-41b6-9b0a-63734b124144", "name": "Product Discounts", "description": { "content": "Product Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "97add9b8-7e7a-4208-8f12-5b40bc17433f", "name": "List all Product Discounts", "request": { "name": "List all Product Discounts", "description": { "content": "Retrieves a list of Product Discounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (Boolean) `apply_to_commissions`\n- (DiscountType) `discount_type`: AMOUNT or PERCENT\n- (Double) `discount_value`\n- (String) `product_id`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=apply_to_commissions%3D%3Dtrue`\n- `filter=discount_type%3D%3DAMOUNT`\n- `filter=discount_value%3D%3D10.0`\n- `filter=product_id%3D%3D2`\n- `filter=discount_type%3D%3DAMOUNT%3Bdiscount_value%3D%3D10.0`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `apply_to_commissions`\n- `discount_type`\n- `discount_value`\n- `id`\n- `name`\n- `product_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "da048abe-c656-4660-b7d1-623594525999", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"discounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43fa095d-3ba8-440d-b772-5fcd88ace0e8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e2afcb-ad80-418d-945b-8b14a13139d7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8185c561-4b10-41c0-89a6-1c650278e4f7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b15a02-4fd7-4cfb-8ae7-ed02c1452e1c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f85814-a1e8-42f9-8e03-fc48288e4fdb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e36c26-a120-4d6a-bec0-7b7466efd07b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cb9e837-8520-4dca-bcec-cb1e1ad73c6d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01408c3c-145b-4b37-9d54-95ebbcc51e90", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cfad501-09e4-4ebb-8c10-27a1c8b36fb8", "name": "Create a Product Discount", "request": { "name": "Create a Product Discount", "description": { "content": "Creates a Product Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "10cfe9ba-a654-458d-b32f-51fd914c3084", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2760110-ff0b-407f-b671-f44ea191ad0d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "739cfe7a-3396-4dea-860e-c820dd8ddfb8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42f516bc-36e6-40aa-a47d-ed855346b506", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7038825-0b3f-4bea-b836-464a10578574", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2238db9-6ca7-48e1-9ca6-9ef9c2dc972e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbde67b6-c0d0-42fe-9ac6-19edfbd513f0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b854822-0bd0-42f6-ae96-d302c9454bb1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50a55fec-cbb4-4867-b3fc-851f9c396114", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20,\n \"name\": \"Summer Sale 20% Off\",\n \"product_id\": \"string\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f430f2fa-e06b-4d0f-a3e1-d56932a9bb2c", "name": "Create a Product Discount Criteria", "request": { "name": "Create a Product Discount Criteria", "description": { "content": "Creates a Product Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0585425b-d439-4222-b9e9-b69e5a7ebc51", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"criteria_id\": \"string\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7811efcd-eac8-43f0-a6a6-3b97d156f28e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c81baafb-bed5-442d-b5b3-052749665b51", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51cdca5-55ee-4f31-8d5f-d12d4adb186c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20503fc6-9dbb-4f2e-98a5-6140e5dfb03f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "060eb559-ffe9-4d26-ae6a-af2378f2c7a2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69932062-8a76-4782-93a7-135aa5454445", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d333357c-bed4-4225-bff1-e80e86c52336", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ed07e2-0b1e-4e97-963e-c3b801b0f20b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49256d46-c9ec-48e6-8bbd-ec00c9a5544a", "name": "Retrieve a Product Discount", "request": { "name": "Retrieve a Product Discount", "description": { "content": "Retrieves a Product Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ea9d68f3-3fa0-4222-aafa-27eb079e2472", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb6a55a8-3969-4706-ad01-1489afb6da9c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f7a21a-05cf-4e18-9311-e83b4e015c27", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87d171c7-637d-4020-a511-e0ba8fd251f1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22828838-64b3-46a0-b683-b1a75f9cf534", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080f65db-72bb-4a2f-b0f9-6ad5498eaf8a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5187c73e-fb03-4c9e-be97-8f66b4bc8ea1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f217652a-ae15-40a6-bcfa-fec4f53a23f6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f919473b-e2ad-4acb-a14c-82766d86a69e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d00b7718-0d38-4102-9c60-f7f6383a5f21", "name": "Delete a Product Discount", "request": { "name": "Delete a Product Discount", "description": { "content": "Deletes a specified Product Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b5d431b4-6f88-4507-86fb-e48788a1877d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94049b58-4212-49c6-9901-9d927e339c33", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b9475cc-9847-4631-b305-4af957306997", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289030f5-e0a5-450c-ac7f-437945f26e43", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ef73c5-b686-4794-a4f5-0dd735a70ba8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0acf1b3-78bf-4aee-98d0-57531d4f1150", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd1e0c5-f529-4d07-ad85-83affadae8b9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96d3763b-b924-4871-a144-98761d074e62", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b641aaae-95f8-43aa-86ff-06a1f4bbd638", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cb882c9-0730-4667-abee-b05893e02911", "name": "Update a Product Discount", "request": { "name": "Update a Product Discount", "description": { "content": "Updates a Product Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "discount_value", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "be1593ac-cbb3-4df1-9e04-ce90eeac0506", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f21b3d3b-0f87-449d-881b-4e4a88d56726", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c380abfa-756e-4b84-8e7f-b2b8849d9aa3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a753d18-0aba-497e-8cb9-287e694fde31", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfea3298-2607-45da-92cb-480e854762ee", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ae3ec2-9d86-445e-9b41-261c2fee537e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaaa4136-3042-4931-9d3e-d3a8ef64840d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec8b8831-8c13-474e-b68c-d58543dd7522", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ab16ff3-fb00-4cb1-9a94-1f8c472a20bb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale 20% Off\",\n \"description\": \"20% off on all summer products\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"product_id\": \"string\",\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 20\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45a5b532-b478-4c84-9bb8-ee6a36bc3e02", "name": "Delete a Product Discount Criteria", "request": { "name": "Delete a Product Discount Criteria", "description": { "content": "Deletes a specified Product Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e372f993-bda9-42c7-8a7f-1ac5e2ef0ce7", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14744c8a-3ae2-41cc-9ad0-85808fe7ae16", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720ce518-617c-4c3d-a11a-cd37d7f3998c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a9533e-a498-4077-ad68-b4c4652d0783", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a31c02-d506-4705-9ea1-c80abd9658fe", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a9d6f8b-9775-433f-996f-082677a20e98", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6241a47-ae66-434b-9fd7-9b6b9dc99db8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7093825-ba81-4b99-b6e4-7f17e5187368", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0afc09b9-b2d9-4b25-8e93-d589666c9a99", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a026cfe3-3152-44ef-8e96-41fbac36014b", "name": "Product Interest Bundles", "description": { "content": "Product Interest Bundles endpoints.", "type": "text/plain" }, "item": [ { "id": "988b46e8-e6d5-4e3e-a44e-68c97512780b", "name": "List Product Interest Bundles", "request": { "name": "List Product Interest Bundles", "description": { "content": "Retrieves a list of Product Interest Bundles", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "11972459-c127-454d-9f81-3fb01622ad8d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"product_interest_bundles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db137b9e-e901-445f-9b1e-aa6eec705134", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "467eed73-f817-4daf-a420-3a09f19926fc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c29b56d6-1f08-4369-9d22-5ec977c6115a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d79c01d-f9b8-4532-98b0-94843630e61b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a15796f-a726-4d13-82d5-2e74a2ec27a7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c87b2911-2b9f-4e39-bbf4-33c1a591957b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad4792f-2fbf-47fa-8330-771679ef4d15", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40666440-bdb6-4dc5-a712-13b414caa4bf", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c010bfb1-4577-420a-9cf4-adc5a33e75d0", "name": "Create a Product Interest Bundle", "request": { "name": "Create a Product Interest Bundle", "description": { "content": "Creates a new Product Interest Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2a1fe13f-3aaf-4148-8591-bbbe97226781", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\",\n \"product_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_plan_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a273f936-1c28-4dcb-bc64-186224619d2e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac01407-bcdc-44ce-a731-7591026168fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad75875b-b6f8-4d82-864b-7880afcee9d6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4e6db54-36c5-4057-839d-850d5caa1370", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d8cce38-e2c5-43b2-809e-9b29b1a01efb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9c542d1-7d8f-4133-b5a7-4dbff8740195", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3075b29-65c4-44ca-a242-9617ab6e1b4f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6755417-24c4-4547-923d-df0bf846e8ab", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"Bundle of premium products\",\n \"name\": \"Premium Bundle\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47eb1e94-8709-4d29-bfc1-0fb2970b00f9", "name": "Create a Product Interest in an existing Bundle", "request": { "name": "Create a Product Interest in an existing Bundle", "description": { "content": "Creates a new Product Interest in an existing Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d18dd13-d338-4c97-ad10-a08263e607e5", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"interest_id\": \"string\",\n \"discount_percent\": 10\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9c8812c-4a4b-4ed7-9150-fae8fb0e014a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb4b35c1-b2af-4fda-8f5c-503d916853f0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5d1a525-8628-4559-89cf-b0959b8251a5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fcc767f-8c51-4a32-beb6-4a9a1c2907b0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9370415b-1b5b-4afa-b299-b876e52ae8c4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae141f95-466c-49c1-a7b1-ec9758c5d3f8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd826922-9fdc-4b70-b830-6fe6c568c10e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6676ed0-679a-4b0e-b50a-b5ca685de692", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"string\",\n \"price\": 10000,\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ae0c39a-1c89-489c-8647-3a57111e5648", "name": "Get a Product Interest Bundle", "request": { "name": "Get a Product Interest Bundle", "description": { "content": "Gets a single Product Interest Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2f7b7932-86ea-4acc-9a80-950a610fa47f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\",\n \"product_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_plan_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b31865-2d7c-4bb6-9445-47a6701f3805", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f563675-fc9b-41b3-884d-a200127c101a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b7f96f-895f-4dfd-a8db-5b367d5ea348", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b836bb3-1c12-4331-9930-c017e73af70b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3581fde9-b4c5-4940-91dc-4ff9e46f4958", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1ac3934-95c0-4830-9a0d-c25fde437918", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e86613d-428e-4011-a714-5eae9e969d95", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "142c7f84-7f80-4c75-9e1b-d59bebb97b65", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "574b0ade-3b60-4472-9d4d-143f8a11a567", "name": "Delete a Product Interest Bundle", "request": { "name": "Delete a Product Interest Bundle", "description": { "content": "Deletes an existing Product Interest Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "aacbb611-19fc-4882-926c-3c5413bbfd16", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4bb9aea-b017-4d6c-9083-e14c61d258e3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0148891b-81d4-488b-963a-755ee4cdb6f4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b75e07-741f-4b69-b0f9-fb57188ec6df", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d502dc72-4a0e-429a-b492-9b59b23dd7d1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "537c304b-7c3b-42fc-b0e3-8d514ba1181b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e829af1a-b99d-4588-b8ce-af405af0a4c9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f842ca31-dcad-4caa-b564-4450f8816a46", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffa31184-cad6-4d55-b1ab-25a3c4fab784", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98fabc55-f245-4683-bd12-d54173e13b1a", "name": "Update a Product Interest Bundle", "request": { "name": "Update a Product Interest Bundle", "description": { "content": "Updates an existing Product Interest Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "14522814-630f-48b7-a4d9-c16ba91ce744", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\",\n \"product_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_plan_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd232f1-d63a-4389-8c26-4b641979ce42", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa3b1cd-1ca3-4788-8c64-9b91f14fcd9c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44ba609-c5f4-4472-bca9-e32a97df60bc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f29122e-d2c1-47b4-a66b-4efb57ff83a8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658e3ea3-f10b-4292-929d-80633ced5977", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd69cdc-7e92-40eb-b038-f955b3a66a34", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046a143d-e401-4deb-a12e-60d8383706fb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57648fe0-ae8e-402a-b9d3-9611234b0e5d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17de789f-5c84-4fd0-9550-61c7b6410ce2", "name": "Delete a Product Interest from an existing Bundle", "request": { "name": "Delete a Product Interest from an existing Bundle", "description": { "content": "Deletes an existing Product Interest from an existing Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "5012a361-3ddd-4da0-9f4c-00975aab4437", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c69df98d-38ea-48a2-bccf-5e6392560bbe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c616038-3263-4cee-94a4-a68c874653f2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b82b34c-5bd5-4b44-bb6d-cf7eb965dc3c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ade7ecf-bd3d-4f08-a27d-21230759365b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "458c66ef-f3fb-486d-b057-f93076870abd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b45d03d4-bf1b-4405-adc8-3eb2376b01fc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "575504a7-9f49-48d6-a6e6-17acfe13d4a6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9c1ef26-18e8-4f89-80a6-9e6190c8ed8d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "639767fa-c3c4-4ae5-8405-d01815ca3c17", "name": "Update a Product Interest in an existing Bundle", "request": { "name": "Update a Product Interest in an existing Bundle", "description": { "content": "Updates an existing Product Interest in an existing Bundle.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "price", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "discount_percent", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f8a6773-e947-42d6-949b-87286a0f9806", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"interest_id\": \"string\",\n \"discount_percent\": 10\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5610f299-0e9f-4314-ab9e-ffb58f72eff1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b69913-7a1f-4536-9b26-9a1c75f492e9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "880f2d46-3cd2-4ecf-bbb7-d7b8b167b9c9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "410ae1ab-8fce-4aa1-8420-2f86424ac5c1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2112e27c-9495-44e8-bccd-edc73fb4471e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54023a61-f605-4ff0-bdb8-04ac3f9d337d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5579c25-9747-470b-9c21-ce6e3513ee35", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74e8a6ef-6ecf-4012-8ae4-062f72753f97", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "93b0c912-6296-4089-b919-364505f6778e", "name": "Products", "description": { "content": "Products endpoints.", "type": "text/plain" }, "item": [ { "id": "e1f421c1-a9c1-477b-9b57-0815e5140227", "name": "List Products", "request": { "name": "List Products", "description": { "content": "Retrieves a list of Products", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name` - Wildcard matching allowed\n- (String) `sku` - Wildcard matching allowed\n- (String) `description` - Wildcard matching allowed\n- (String) `short_description` - Wildcard matching allowed\n- (String) `product_id` - supports comparison operators: `==`, `>`, `<`, `>=`, `<=`\n- (List[String]) `product_ids` - accepts a comma-separated list of product IDs\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n\nFor the filters listed above, here are some examples:\n- `filter=name%3D%3Dtestsearch`\n- `filter=name%3D%3Dtest*` (starts with \"test\")\n- `filter=sku%3D%3Dtestsearch`\n- `filter=sku%3D%3DSKU*` (starts with \"SKU\")\n- `filter=product_id>5` (product ID greater than 5)\n- `filter=product_id>=10` (product ID greater than or equal to 10)\n- `filter=product_id%3D%3D42` (product ID equals 42)\n- `filter=product_ids%3D%3D1,2,3,4,5` (products with IDs 1, 2, 3, 4, or 5)\n- `filter=name%3D%3Dtestsearch%3Bsku%3D%3Dtestsearch`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `sku`\n- `last_updated_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1d8796bd-a8a1-4c75-aa95-a2dd4a40de92", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4995e0bc-d609-4517-bea0-9cec430936e9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc765fb7-96a2-4626-b240-8b7e508bc20e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa62dc8d-0d68-49d5-bae3-c73f6d867e42", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94cbf947-402a-4a5b-8e91-4a980039e90c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ceb1de6-7ef8-4f94-992e-25a5c1b8b935", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede1c664-630b-4616-8e7f-48b862f59cdf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48f628f5-f304-42de-887c-1ae49ee150f5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84c83f27-4887-429f-a20e-e456dc9a3598", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68385f6a-52cf-416e-a3e1-93f2c310abf1", "name": "Create a Product", "request": { "name": "Create a Product", "description": { "content": "Creates a new product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5da4cc55-b64b-4402-b34b-a6909a9af628", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a76e326f-95be-48d5-873c-4ca61dd301bd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448d29d4-99cc-42a7-a23f-645f03ee3ffd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d042f80-364a-4d20-8d56-6c424447c9b5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f32b2d1-af01-4463-ba23-7d78678db623", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf4c864-4dc1-4ab5-8155-a1abd7727f54", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "679e12ab-ccfa-47d8-9d5b-833631799500", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d5ed54-bb56-45f8-9236-dfc15cc98729", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbfe5d6e-0482-43f6-95dc-b617c1bd918f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"price\": 1250,\n \"short_description\": \"Premium widget\",\n \"sku\": \"PROD-001\",\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbfe8db1-3571-430c-9bf1-afe586b79495", "name": "Adjust Inventory of a Product", "request": { "name": "Adjust Inventory of a Product", "description": { "content": "Increase or decrease the quantity of the Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "00e2eb43-22ed-4c70-b8f6-4f7e7f8a6de0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd2579aa-ae1e-4938-af32-a7e6c10f3da8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2296737-b9cb-4479-99f4-f1c674693252", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee681784-3291-45c6-973d-a2623e73b958", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d2dc4e7-040d-4701-95a5-81a8e01a9dfe", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "646d83be-bb7d-4f2d-a8bf-db54938148a0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7865662f-8815-4663-af63-bf19e0a2031a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d533c0a-0af7-4d04-b25d-6f71bee675c9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326788be-a1d0-4328-800d-2cefa5b570b5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 7264\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9be562da-bc82-4f6f-97f7-a1a03d2af035", "name": "List Product Options", "request": { "name": "List Product Options", "description": { "content": "Retrieves all options of a Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "89ea4916-7e80-4b53-bdd2-75a15e241ac8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"product_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a4cd71c-a7ff-4846-8392-94f0e41bd80a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35bdfac5-61a4-4cf7-952c-48ffc17b97a4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "901dfbf2-1d0f-4386-8d52-85151e4ff29c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dc25fde-c9fe-4a86-a2f5-9df42c66f477", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3138bc7-a508-4d16-b03c-14c46edb617f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd97ce1e-97bb-4389-b8af-efe0ea940b2f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0343853a-23a9-4f6a-b4f0-8d70380e39e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0398ef17-f88d-4ecd-9ec4-58a9e96fc16c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8db360ad-cd2d-4c13-8b8a-220fcebdedeb", "name": "Create a Product Option", "request": { "name": "Create a Product Option", "description": { "content": "Creates a new product option", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9878,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "41f16ba0-6bdf-4220-a7a1-d4662fb47339", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": true,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 4617,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1404107a-0915-4fb5-a9bc-6ac77375404c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1aba8c-11da-49f6-b229-e76546bf9f6f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7331a012-e816-400f-a004-e5ce1bc60d36", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aaa8859-e6cd-4778-97f1-f11702c2f117", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66f2c0a6-1092-4380-9022-28472e1b1fb9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6142adc-9f9a-4b0d-9c74-5cf68e4010e1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55efacf8-0290-4f35-965c-41a74da1466e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3128a43-1b6e-4dc1-84f3-54f6c1108260", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9282,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37ecfadc-1a2b-4b3f-8959-b273b141ec30", "name": "Add a Product Option List Option Value", "request": { "name": "Add a Product Option List Option Value", "description": { "content": "Adds product option values to a product option of type LIST", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed982aac-6f93-4a02-ab84-c75748a72889", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": true,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 4617,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907f435e-9c54-4282-955a-92607e6effe6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24834887-c093-4af5-8f87-d7b991976737", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f6877f5-690f-4a31-a6bc-43ab78fe22f3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26aec9f9-94e1-4ecc-a0b6-f3ef1bd6a72d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f7e60d6-dc5b-409c-9209-78f03ccb81b5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023d3315-ad55-44bb-8741-4c0838745d5c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b3fa60-ea11-4776-9151-4f696074991f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1374e4a0-ff21-4158-979d-3593b2d019ea", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n },\n {\n \"item_label\": {\n \"value\": \"\"\n },\n \"item_code\": {\n \"value\": \"\"\n },\n \"item_display_order\": {\n \"value\": \"\"\n },\n \"price_adjustment\": {\n \"value\": \"\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbcd662b-5082-4490-92bd-1ac3ad3f7180", "name": "Create the Product Image", "request": { "name": "Create the Product Image", "description": { "content": "Creates the Product Image file and uploads it to the specified Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "legacy", "value": "false", "description": "Set to 'true' if the product image should also be used in legacy cart features. Only one image is allowed. If an image already exists, it will be replaced by the current image." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) The image file to upload" } ] } }, "response": [ { "id": "3387e245-2b99-4e6e-a3d7-1dccfc32fcbe", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aac61ff6-d5e8-4ef2-99f5-a36c6e847c85", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99adf7b-fa05-4d33-b4c2-d299450770c9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d86419f-ff4a-4214-929e-c4086eb2ce12", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ee0223-c2c3-44bb-a975-1806746c6e32", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d99bc9-0084-44e4-aeb0-c3c64a5b7366", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01732aa8-e495-48ae-87fd-2b49804ea877", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e239129-5a85-4098-93f5-e4876082a435", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93e37fa-fd82-4c19-8d90-30855ec43695", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "653918dd-4baf-439d-913c-761a24d9fd38", "name": "Delete the Product Image", "request": { "name": "Delete the Product Image", "description": { "content": "Deletes the Product Image from the specified Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "3a717d36-c7f8-4df6-b4a0-02c774c85bd2", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81933e62-22a6-428d-bc99-465d903ee704", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea875315-0c6c-47f6-994b-45c2fc7c6d2f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bb8a435-b125-4964-8ca1-59c9f13e8f5c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6087c04-5d26-4f3b-b89d-7fbfc9a75e09", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5b9b57-1eff-4b16-9daa-4f5767d801ff", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "068e59bd-879c-43b1-b892-41d25b59b9b7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317f09ab-4511-4d82-a363-18fa253c78eb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1978bb4d-e0c2-40f6-bb40-b31fb0eee891", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d300d39-0ec5-4cdd-a27e-baa8db229c7a", "name": "Get a Product", "request": { "name": "Get a Product", "description": { "content": "Gets a single Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "01fa00a3-c0b2-47df-9c50-cd00985dba7e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "192b6478-8ad1-494e-956c-22b87641d24a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d37147fa-8220-4700-845d-77048eee4561", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed0fce60-4894-4d65-aec3-9bf708ac17d8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2abc6883-94df-4e2f-a50e-68e8b641da07", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62d0a27-cbc8-41cc-9f66-1ed7b73d7789", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa062521-3283-46b1-90a1-4990b759649e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73ff79a0-4e31-42a9-a091-fa8fc69657a3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0349fe43-621e-4b91-8db1-9f05e0459907", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee2ac5f2-7817-4da9-ad14-3fbfad3f0c6f", "name": "Delete a Product", "request": { "name": "Delete a Product", "description": { "content": "Deletes a single product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c80b16dd-43e4-4276-8148-a06cd674d3ba", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63837e69-cec1-48eb-8e77-452bdd839dc0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23c1496-c149-4ba6-9af8-66b9dad4b490", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68086924-854e-44cb-ae7d-804b8b10b088", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffadbaed-cc77-40ef-8eac-7be64b327fe8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c8f4579-10e5-4018-a317-d656c3ad37be", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b29ed304-402d-4be8-8505-6ebdefb09e84", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ce59fc-dbc8-4a44-8aab-5ba3c104208d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2763a7a7-fc97-4ddb-a990-8072e37d2f8b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1aab5490-3fa4-44c5-ad90-1863d22691a2", "name": "Update a Product", "request": { "name": "Update a Product", "description": { "content": "Updates a product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "subscription_only", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fe9e3f59-6da4-4e49-8f7c-ac61e55a0727", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": false,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "266e8c9e-c5b5-4197-87ba-f156f679b626", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14a540d2-6d35-40f9-826f-28ea6fade415", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6b6c35-a3ba-41f0-83a5-8ba34b485370", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5697ef90-5d5d-41a3-ad0f-08999d1be712", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "470b3139-e60e-400a-8144-85456f4046fe", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29378bf7-611d-420a-b390-f30806b33067", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1398abd4-d5ca-4b31-8852-9fc8f30bfa21", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9222ddc1-c569-4eac-a651-dcbb8bdef9c5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_for_inventory_notifications" }, { "key": "update_mask", "value": "inventory_limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0569d74-0a22-4b78-8de6-02de81e688af", "name": "Get Product Option", "request": { "name": "Get Product Option", "description": { "content": "Retrieves a Product Option", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3135953e-e20f-4d8f-aaa0-796c6115a5ee", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": true,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 4617,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "339155bb-019f-4a2c-b768-df88a2381317", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad7c2cb8-c971-4bea-b0b8-90dd7b758d63", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a7602f-9ad8-484c-b667-79e6c1dc2337", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb83500b-51f9-4eb2-b5f8-efa7a8fc6275", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47294313-26f3-4e27-af6a-33f9dc0797b1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21ac2933-e07d-434d-a7d4-b4ccb7bd625f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6c7491-b39f-4acf-906a-83173ca3248f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31cc58cd-4877-48fd-8ea3-5b405b2fc0c7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31a23707-2f1e-4a48-9875-04725b51117e", "name": "Delete a Product Option", "request": { "name": "Delete a Product Option", "description": { "content": "Deletes a single product option", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1b1470e7-6903-4dbf-8700-fa1b99cbee6b", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0ef20a4-2630-4dad-9781-072353fa5355", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "148be07c-8865-4fb8-b9eb-380f4ef577d2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df6b6638-9e02-4f73-9df2-f0ee2c68e368", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a44dcbc7-fb19-46d3-a36a-bdef0cd5e8e1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c5bcb1a-37a6-42d1-ac94-fbaa2253f321", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bec7a41-aeae-441d-b2cc-80239c396f4a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a6b724-8976-45f1-bdc7-ee24faf0f435", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ab3286f-80dc-4411-bee8-7de8f0a7dc8e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfb08861-446d-43ce-b255-e6826be41feb", "name": "Updates a Product Option", "request": { "name": "Updates a Product Option", "description": { "content": "Updates a product option", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "allow_spaces", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "option_label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "51dc3332-ec40-479b-bbfd-35557017ee52", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": true,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 4617,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b4b240c-310d-443c-a6e7-a45b9a1408fe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea4beba-567a-402d-8e32-34695becc4c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05f981d9-6e4f-4b32-8148-3d10e6a274bc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b33211f0-b7d2-49b9-bc00-d250baeed8ac", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "588df3a8-31cf-4a20-9863-f7973ef5e436", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df831c6-77a5-4299-ae18-e1201f4d1cec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6564d3d0-dbe5-4f37-94b1-1a11fc2e99c4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18fe2e75-b585-4454-8f9b-122e479c51af", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_starts_with" }, { "key": "update_mask", "value": "allow_spaces" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6804,\n \"minimum_characters\": 1344,\n \"maximum_characters\": 7587,\n \"allow_spaces\": true,\n \"only_starts_with\": \"LETTER\",\n \"only_ends_with\": \"BOTH\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2343279e-e1a4-4edc-b30a-df6b1b000893", "name": "Delete a Product Option List Item", "request": { "name": "Delete a Product Option List Item", "description": { "content": "Deletes a single option value in a Product Option of type LIST", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ebb0912e-1d23-4ecd-a103-8000b016403d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6732141c-227c-477b-9b13-254a00dbc24a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ef679fe-b551-4edb-9f2d-d89bbc8408f4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbefc6f8-1b7c-474b-90b2-d1d3d821af96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be94f6fc-fbc5-4795-8ceb-3fae5346233b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40b45035-9608-4afa-b083-cd9902a59974", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0624e5-cd13-41d8-8764-cb7ace5bbd83", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4208dcf1-75ae-485b-b6bc-30c34e6d4752", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe38766d-310e-48f4-ae9d-9460ae9b449b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34b0e4d0-d1d3-445c-af0f-a7be3e60b334", "name": "Updates a Product Option List Option Value", "request": { "name": "Updates a Product Option List Option Value", "description": { "content": "Updates a single product option value", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "price_adjustment", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "item_label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1fc93b5f-dd26-4a29-9e71-43c23da9db6a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": true,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 4617,\n \"list_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"text_rules\": {\n \"minimum_characters\": {\n \"value\": \"\"\n },\n \"maximum_characters\": {\n \"value\": \"\"\n },\n \"allow_spaces\": {\n \"value\": \"\"\n },\n \"only_starts_with\": {\n \"value\": \"\"\n },\n \"only_ends_with\": {\n \"value\": \"\"\n },\n \"only_contains\": {\n \"value\": \"\"\n },\n \"error_message\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90d9323d-570e-4aec-bc1d-5d5b7cfdb27d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e17470-c1f1-4a15-9232-8c883f0b798c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9a9a1b-893b-4c03-ad0b-c45d1b673185", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "374e0d0e-01f9-49ba-8547-865398b01b5a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66df9a14-b711-4ede-86fc-1a53330a66dc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f24ec6-7b52-4e4a-bc8e-d767239eb006", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f087a0-d998-420c-a806-44cd1460ea01", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba6e4ed5-c270-481d-b272-19d2ae50555c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_label" }, { "key": "update_mask", "value": "item_display_order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 7170,\n \"price_adjustment\": 7698.350506615121\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16c4f9cd-6899-4e45-9f19-3fa0e6f7b776", "name": "Retrieve Product Legacy Image Data", "request": { "name": "Retrieve Product Legacy Image Data", "description": { "content": "Retrieves the product's legacy image", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "af51e24c-3b7f-4f8b-82c1-17ba56e8f305", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07ad76b4-7d6c-48e5-ba6f-b5087a765359", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca4f7b4-3bbb-430f-9320-bd18a1bb3164", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a9ca5d-6911-4383-bda8-adcfa5a41878", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07fd5d4-8e62-4cdf-9ab1-94f2b5c7c1c1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c2566af-5753-4489-8d81-1eabc50d74dc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f58d5d-d64b-437c-bc81-68ac00b26cec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9728cf-2bc9-41bf-98a1-3fb72ae320c5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aeb4f3e-dff9-4753-895f-a59403abb316", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images", "legacyImageData" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b6e06b26-4179-4377-81a5-0aa72df0d13c", "name": "Referral", "description": { "content": "Referral endpoints.", "type": "text/plain" }, "item": [ { "id": "07bcbe77-55f6-41a4-bb65-3b59a5ec8fab", "name": "List Referrals", "request": { "name": "List Referrals", "description": { "content": "Retrieves a list of all referrals with optional filtering and sorting", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `referral_partner_id` - Allowable operators: \"==\", \"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `contact_id` - Allowable operators: \"==\", \"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `source` - Wildcard matching allowed\n- (String) `description` - Wildcard matching allowed\n- (String) `type` (Allowed values: `COOKIE`, `PERMANENT`, `MANUAL`)\n\nYou will need to apply the `==` operator (or other supported operators) to check the equality\nof one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above,\nhere are some examples:\n- `filter=referral_partner_id%3D%3D123`\n- `filter=referral_partner_id%3E10` (referral_partner_id > 10)\n- `filter=contact_id%3D%3D456`\n- `filter=contact_id%3C%3D100` (contact_id <= 100)\n- `filter=source%3D%3DEmail Marketing`\n- `filter=source%3D%3DEmail*` (starts with \"Email\")\n- `filter=description%3D%3DReferred*` (starts with \"Referred\")\n- `filter=type%3D%3DCOOKIE`\n- `filter=referral_partner_id%3D%3D123%3Bcontact_id%3D%3D456`\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A)\nfor case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `referral_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "783b0af0-d37c-425b-9d06-96366f80f0e3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"referrals\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38bc0de5-1d57-4be6-ba95-9c26f44ee620", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd4f1aa-bd4c-41c6-848b-e08f623b9ef6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2d39e8-ce67-440c-8cfb-da49c8a8b846", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00722814-7de6-4f7c-b81f-78ac5d2c6920", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b44a1c7-169d-4782-aca0-f9df1d5c6a53", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "177470b6-04f9-4cfb-a929-226db12dc154", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82e29f1b-e9ae-440b-970b-29eeacb17da0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "620e062a-e748-498f-adbc-8f0ae53fa26a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f2bf8fe-3e48-47af-9e76-0002c3bf936c", "name": "Create a Referral", "request": { "name": "Create a Referral", "description": { "content": "Creates a new referral partner referral on the provided contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c65d6ce-bc42-4f4e-a5f0-8dbb3dd3021f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"contact_id\": \"string\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T23:00:00Z\",\n \"expiration_time\": \"2024-08-21T23:00:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07c6e178-4814-4ff4-b8c2-36f0676e295e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "962b2abc-f4da-406e-936c-4e1e9e72c294", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "802a1a30-7832-4d13-8e93-4bf1af83de74", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fafb83e1-b094-4d93-9b4f-0e6ee83a35db", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e95e65-a215-4f8f-a94a-1e91d05f6f5e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39bd12df-7ae3-44e2-9ecb-e9f029ba7268", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f11a5894-3e60-455d-9bd6-996ed481dc41", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72c3e430-8e23-41fd-bb2d-0f1ab7b4be5e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"description\": \"Referred via email campaign\",\n \"source\": \"Email Marketing\",\n \"referral_partner_id\": \"string\",\n \"referral_time\": \"2024-05-21T14:30:00Z\",\n \"expiration_time\": \"2024-08-21T14:30:00Z\",\n \"ip_address\": \"192.168.1.100\",\n \"referral_type\": \"COOKIE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b79486ce-11fa-461a-92c4-085806cd1009", "name": "Reporting", "description": { "content": "Reporting endpoints.", "type": "text/plain" }, "item": [ { "id": "1239eda3-6206-4a6a-a699-f4229d3afb92", "name": "Run a Report", "request": { "name": "Run a Report", "description": { "content": "Runs a report as defined in the application (identified as Saved Search)
Deprecated as of v2", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page_token", "value": "string", "description": "(Required) " }, { "disabled": false, "key": "order_by", "value": "string", "description": "(Required) " }, { "disabled": false, "key": "page_size", "value": "7145", "description": "(Required) " }, { "disabled": false, "key": "fields", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "29faf117-a678-4f20-820c-02356f32125c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"page_token\": \"eyJsYXN0Um93IjoxMDB9\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc4948a-e7fb-48e0-bffd-158d1a907472", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac0abee3-e077-4344-aea1-1e0bafc28f03", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc53dad3-6da9-4d7f-80ed-6c5870c5fc86", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f42fcec9-170e-47da-a0b9-50d4fa55f011", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8f0ac6f-1ff3-4b48-acbf-be3e37c31fdc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e3164a5-ad9d-4942-8189-aeb25d2e1e49", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3109645d-c430-40c3-a8e0-7372f3629305", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65a5bfa2-8ba6-4b22-98ec-645182ff7ca3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", "{{report_id}}:run" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "7145" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fafa12f-4fc2-4271-a445-d5119450bd02", "name": "List Reports", "request": { "name": "List Reports", "description": { "content": "Retrieves a list of Reports as defined in the application (identified as Saved Search)
Deprecated as of v2", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "name%3D%3DMonthly%20Sales", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (DateTime) `since_created_time`\n- (DateTime) `until_created_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\n word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=name%3D%3DMonthly%20Sales`\n- `filter=since_created_time%3D%3D2024-01-01`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "name asc", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `created_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d5cbd18a-e8d6-4246-bd40-4406b8ed0242", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reports\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30878853-739d-4efd-a1f4-0a8a6f3fd910", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21adec0a-3b7d-45c6-a42a-7e13d31223e5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18705da0-6b1c-4c34-b413-adee6b16cf53", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af80cc4d-1d3d-491e-b9f8-e78a4666ea09", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3be97b24-706b-44dd-9eda-043b8ecbe92d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d151ee-bd5c-4df3-adfb-945eaf859304", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba570966-bb23-41a2-9f3c-6310128cf06b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57cb2309-0570-4cba-a91d-fcde5a89236f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "name%3D%3DMonthly%20Sales" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "name asc" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7b4c822-3ed8-41ec-8240-4ca054eb391a", "name": "Retrieve Report", "request": { "name": "Retrieve Report", "description": { "content": "Retrieves information about a Report as defined in the application (identified as Saved Search)
Deprecated as of v2", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9817bb9a-43b9-4398-9f46-f6dace4c9c7a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Monthly Sales Report\",\n \"updated_time\": \"2024-01-15T10:30:00Z\",\n \"created_time\": \"2024-01-01T08:00:00Z\",\n \"user_ids\": [\n \"1\",\n \"2\",\n \"ALL_USERS\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "294f3a04-dca4-4e60-97e0-5f6d1422d63d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70c44da7-4951-4bee-a9b9-cf98e6901ac3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b98fe060-4343-4ef0-b84c-c5a326c37c09", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a85fa62c-265e-4abd-a6d7-29ba19a42475", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe001ef4-7f2c-4514-9b2d-ab0dfc4d0d5f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a110a0e1-1ee1-4e53-aed0-8a7bc9703306", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ceb77d-4190-406b-acfd-7f24ad9bc8d5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b710f03-1516-40f1-9fa6-07228aa00d35", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0bda9d7b-b7dc-47b1-a9d4-e966b359880e", "name": "Retrieve Report Model", "request": { "name": "Retrieve Report Model", "description": { "content": "Retrieves the list of fields available for a Report (Saved Search). The returned field `name` values can be used in the `fields` parameter when running the report.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "581d68f6-d9a8-4d9d-9069-00f6a55cba78", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fb11cee-c936-44a3-98a5-8854afdf4097", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c6a3291-b525-42c0-b9fe-9bc2e49ed029", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f4ee68-831b-40f2-8d49-24d9847255e5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc30395-ac66-48c4-bb6d-d35c02501f1c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "397a58d5-7182-4f78-9178-909230fe8a45", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8af5ae9-f048-4530-9bd1-69da25ebd1ef", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3943f8df-0641-4fd8-a087-66b0282a4c67", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "214ac1f3-2f3a-4c8a-8ea4-251a6fc33cde", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "reporting", "reports", ":report_id", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "report_id", "description": "(Required) The unique identifier of the report (Saved Search)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ae5beded-a655-40fe-b7fe-6b21834116c0", "name": "Sales", "description": { "content": "Sales endpoints.", "type": "text/plain" }, "item": [ { "id": "1e7d1092-3272-4db6-90f6-2c9aaf6a8897", "name": "Set default Merchant Account", "request": { "name": "Set default Merchant Account", "description": { "content": "Sets the specified Merchant Account as the default Merchant Account.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "5895aa83-50cb-4d75-ab4b-0bbd4bf726cf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5fef408e-ca26-4cfc-9c15-f25d900e4667", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66fc2cff-e088-4737-bf04-7434b71e8ac4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a5d9d8-a9a8-4797-a040-058412f1f078", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5bf7a1-efb6-47c2-9d3f-2f4533f98ec8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8dbd3bf-29b2-4f95-8c57-9c34ba12ddf6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef556063-f2fc-4b2e-ae08-bdce22c65830", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb32e1d-4857-437c-bd0b-d7c347e6380c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e83ccbd4-6feb-4013-9033-51f03ad75cef", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "merchants", "{{id}}:setDefault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcbc3e85-0881-4b76-99e7-77b30abbb423", "name": "List Transactions", "request": { "name": "List Transactions", "description": { "content": "Retrieves a list of sales transactions", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `amount` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `order_id`\n- (String) `contact_id`\n- (String) `since_time`\n- (String) `until_time`\n- (String) `merchant_account_id`\n- (String) `merchant_account_type`\n- (String) `status`\n- (String) `transaction_method`\n- (String) `is_successful`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=order_id%3D%3D123`\n- `filter=order_id%3D%3D123%3Bcontact_id%3D%3D567`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `amount`\n- `transaction_time`\n- `contact_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "405ea897-a347-4072-affb-62a9b82f58df", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e55d6a2-bec7-40d4-81a6-d55bae44ce50", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cc7dbc6-c68b-4b15-84f4-765187eebb02", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18c8e482-5cfa-4d4e-b882-9ed0d14d2878", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84dc4de6-73ca-4c1d-8a03-5360c625e924", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1beb1c10-1cb8-4b36-8b13-7cfd45bb53bd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2eeffa3-0c15-4bee-b304-37355a1e07e4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a663138-9d1b-4054-a3df-f6f2c86d8ab6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7525763-d43e-4a8b-9aab-c1a2ed660add", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4b4f519-c341-4086-900f-eaee1bfc8a37", "name": "List Payments", "request": { "name": "List Payments", "description": { "content": "Retrieves a list of payments", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `id` - Allowable operators: \"==\",\">\",\">=\",\"<\",\"<=\"\n- (List[String]) `ids`\n- (String) `amount` - Allowable operators: \"==\",\"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `order_id`\n- (List[String]) `order_ids`\n- (String) `contact_id`\n- (String) `since_time`\n- (String) `until_time`\n- (String) `merchant_account_id`\n- (String) `merchant_account_type`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=id%3D%3D123`\n- `filter=ids%3D%3D1,10,4,24`\n- `filter=order_id%3D%3D123%3Bcontact_id%3D%3D567`\n- `filter=order_ids%3D%3D1,2,3`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `amount`\n- `payment_time`\n- `contact_id`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cca56a87-71ca-4ae3-993d-30591f9cbcbd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f627fde-f90e-4834-ba0d-1504f06ca482", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acb9f94a-9e1a-447a-b1a4-c8319eb9ab43", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b070c03-282d-48e6-b09c-6a7c9b455b85", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c0552e8-7126-4da8-87b8-8e69409d542d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3bf7797-a55a-4e1d-bab3-6d1e29ec0f45", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdac57db-4b79-4ad6-84d6-ac1392735d6a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5369a539-13c0-462d-8372-2f42ad939687", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d2850b9-21ab-4d0e-a905-e6a6320c2f8b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "sales", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "01951036-8c8f-4f3b-ad3b-e4ab01954110", "name": "Settings", "description": { "content": "Settings endpoints.", "type": "text/plain" }, "item": [ { "id": "3f4d22ab-7736-44bb-ab18-74e30edad198", "name": "Get Contact Option types", "request": { "name": "Get Contact Option types", "description": { "content": "Gets a list of Contact Option types.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "700ba0dd-4fea-40de-b2f6-d9041bd898f6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"option_types\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a84d43c2-c8e2-4ff0-bcab-6b3b973e8106", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0a8ae4-29c6-46ae-93be-33470534a2b1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1243897-65b7-4fd9-9313-9efdb2794f8a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccc29f7d-c596-4653-ba01-ac8f69d16cce", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "872c05af-1489-4757-96d3-5f25714425d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac9a38d-80e9-478b-b9da-3e693da07c90", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db6b9ff-2ec9-4437-b175-6ef259059150", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c12c94ab-44e4-4dd2-9da8-987568eb2396", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "contactOptionTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1f84fcf-1b15-40b6-8aeb-9d5dfd551693", "name": "Get Application Status", "request": { "name": "Get Application Status", "description": { "content": "Check if the application is enabled or not", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "117f556e-a321-4695-993b-28e872c664f5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"isEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45fcbe4a-b4e3-4063-b0f6-cbdab4103871", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0b9e8c-3ec7-4c8e-8c14-8537d31c2dce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a3619a-02b2-499e-9717-5d7292d106a4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db5226b3-80ce-4d85-93d5-5830b8d82d19", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c57378-59d7-45f7-b4c3-f02cd52927c0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3d61192-60e1-4c2d-ad10-bef0f9e48d58", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb30e077-a524-4876-9d5e-71c76dd506a8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de84afdb-41c5-4de9-96ae-d65a7ad19a83", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9899a692-7b3f-46bb-be3e-7db3331182ab", "name": "Get Application Configuration", "request": { "name": "Get Application Configuration", "description": { "content": "Get configuration values for the application instance.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "OPPORTUNITY", "description": "By default, only application data is returned. In addition to that, data is returned for the fields that are mentioned in the query." }, { "disabled": false, "key": "fields", "value": "FORMS", "description": "By default, only application data is returned. In addition to that, data is returned for the fields that are mentioned in the query." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "daa918d6-b202-430f-b1bd-e4d0476723e7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"affiliate\": {\n \"commission\": {\n \"value\": \"\"\n },\n \"choose_affiliate\": {\n \"value\": \"\"\n },\n \"custom_affiliate_url\": {\n \"value\": \"\"\n },\n \"display_affiliate_ip_address\": {\n \"value\": \"\"\n },\n \"do_not_notify_affiliate\": {\n \"value\": \"\"\n },\n \"use_referral_history_if_no_tracking_cookie\": {\n \"value\": \"\"\n },\n \"skip_pay_if_unused\": {\n \"value\": \"\"\n }\n },\n \"appointment\": {\n \"appointment_types\": {\n \"value\": \"\"\n },\n \"share_opportunity_with_related_user\": {\n \"value\": \"\"\n }\n },\n \"application\": {\n \"company\": {\n \"value\": \"\"\n },\n \"time_zone\": {\n \"value\": \"\"\n },\n \"default_view_locale\": {\n \"value\": \"\"\n },\n \"features_enabled\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"title_types\": {\n \"value\": \"\"\n },\n \"suffix_types\": {\n \"value\": \"\"\n },\n \"contact_types\": {\n \"value\": \"\"\n },\n \"phone_types\": {\n \"value\": \"\"\n },\n \"fax_types\": {\n \"value\": \"\"\n },\n \"address_labels\": {\n \"value\": \"\"\n },\n \"disable_contact_edit_in_client_login\": {\n \"value\": \"\"\n },\n \"default_new_contact_form\": {\n \"value\": \"\"\n }\n },\n \"ecommerce\": {\n \"currency\": {\n \"value\": \"\"\n },\n \"default_country\": {\n \"value\": \"\"\n },\n \"default_merchant\": {\n \"value\": \"\"\n },\n \"credit_card_types\": {\n \"value\": \"\"\n },\n \"default_tax\": {\n \"value\": \"\"\n },\n \"payment_types\": {\n \"value\": \"\"\n },\n \"default_to_auto_charge\": {\n \"value\": \"\"\n },\n \"default_charge_max_retry_attempts\": {\n \"value\": \"\"\n },\n \"default_number_of_days_between_charge_attempts\": {\n \"value\": \"\"\n },\n \"merchant_account_max_retry_attempts\": {\n \"value\": \"\"\n },\n \"promo_codes\": {\n \"value\": \"\"\n },\n \"track_cost_per_unit\": {\n \"value\": \"\"\n },\n \"track_inventory\": {\n \"value\": \"\"\n }\n },\n \"email\": {\n \"default_opt_in_link\": {\n \"value\": \"\"\n },\n \"default_opt_out_link\": {\n \"value\": \"\"\n },\n \"whitelisted_domains\": {\n \"value\": \"\"\n },\n \"hide_emails_to_and_from_domains\": {\n \"value\": \"\"\n },\n \"append_contact_key_to_links\": {\n \"value\": \"\"\n }\n },\n \"forms\": {\n \"spam_filters_enabled\": {\n \"value\": \"\"\n }\n },\n \"fulfillment\": {\n \"default_message_to\": {\n \"value\": \"\"\n },\n \"default_message_fields\": {\n \"value\": \"\"\n }\n },\n \"invoice\": {\n \"tax_label\": {\n \"value\": \"\"\n }\n },\n \"note\": {\n \"appointment_types\": {\n \"value\": \"\"\n },\n \"share_opportunity_with_related_user\": {\n \"value\": \"\"\n }\n },\n \"opportunity\": {\n \"states\": {\n \"value\": \"\"\n },\n \"default_stage\": {\n \"value\": \"\"\n }\n },\n \"task\": {\n \"appointment_types\": {\n \"value\": \"\"\n },\n \"share_opportunity_with_related_user\": {\n \"value\": \"\"\n }\n },\n \"template\": {\n \"default_country_code\": {\n \"value\": \"\"\n },\n \"default_user_id\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "431d2638-26f2-4f2d-babc-14a925c68d07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4588bc38-42f2-4bf0-81c2-225385f475d4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4101d7e6-ca4e-4e8b-8c3a-5c63f30534df", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f9fa8a-8d89-456d-b6f8-4d6ec0debf98", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f63b4c-5094-4248-9324-46247efe415b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614cf327-8a11-4921-ad62-33303f99670a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f5e79e0-dbb3-449d-bfe8-f06874d1e884", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9d2aa10-943a-4620-b3ce-c352bcb01657", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "INVOICE" }, { "key": "fields", "value": "FORMS" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d6752063-3ee4-42e2-b3ce-bbd0e62ad7fa", "name": "Shipping", "description": { "content": "Shipping endpoints.", "type": "text/plain" }, "item": [ { "id": "1e607e56-63ae-4e2f-99f6-cc4c980b59b6", "name": "List Shipping methods", "request": { "name": "List Shipping methods", "description": { "content": "Retrieves a list of Shipping methods", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "12b33db8-bba1-4ca0-a742-5bdfef065bf0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"shipping_methods\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e45713-8716-445d-bf45-b47b98630468", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d44bb3f-c94c-4c79-866c-216cb0603a43", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac34ccc1-b684-4425-9c4c-d8587419b6e4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2d4afed-3932-4c19-801d-f4a4cd554303", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1058a92c-e7f9-4f7d-bf30-455cf172d054", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "006de65d-2ca9-46f8-bc32-dff8745a2af8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4afa92d-d541-4beb-8fa4-bdc27bb066f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9631c91b-2dcb-42d4-a4bb-98e104d4d92e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "72e56e77-7171-492d-91be-f3f17028a0a0", "name": "Shipping Discounts", "description": { "content": "Shipping Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "06c8cec4-5be5-4897-838e-17fb8c8c7a61", "name": "List all Shipping Discounts", "request": { "name": "List all Shipping Discounts", "description": { "content": "Retrieves a list of Shipping Discounts", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (DiscountType) `discount_type`: AMOUNT or PERCENT\n- (Double) `discount_value`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=discount_type%3D%3DAMOUNT`\n- `filter=discount_value%3D%3D4.5`\n- `filter=discount_type%3D%3DAMOUNT%3Bdiscount_value%3D%3D4.5`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `discount_type`\n- `discount_value`\n- `id`\n- `name`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b6384367-6286-4e6a-9d82-d6dec65b42fc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"discounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82ab9f83-de11-4e61-9720-ad45ea422781", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2278b77-1da9-4d88-8e54-f75c58b9dd85", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9028f8c-44bf-46d0-96e2-bb25cc327a42", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b864232-3fcd-425e-9cdf-1d9621a82716", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3053a3a2-2c0b-423e-b147-0010fc3f71f9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d64e9491-bed6-4865-91ef-d750c6c608a1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2d6e181-384c-4fe6-8a63-11ca27837ff6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7599fab-2411-44b1-94b0-61a13ff21cbc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9ed0d64-bac1-4fbe-b136-9a51be468262", "name": "Create a Shipping Discount", "request": { "name": "Create a Shipping Discount", "description": { "content": "Creates a Shipping Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a89f98a3-9fff-4926-94f9-5268a5d29c1e", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1336425d-7031-4954-b0aa-7a3a5bfdf9d9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be8ad03-c9ab-4538-8b68-3747033d09c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6a5d0ff-04ab-49b7-b2e1-35931e3a047a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea1f345-1229-430c-a3f8-e4cec88b350b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dcb1921-b94e-4b5a-976c-5c020ac0f40a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f206aa82-d943-4a42-aa0f-c89f30f2f972", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ece01cf-e642-4637-ac17-8a4f38ce64e6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b92880-d5f0-424f-8ac1-1d2aea1d92ea", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100,\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0ed12b9-e90a-4446-b74f-17dec08b5dc1", "name": "Create a Shipping Discount Criteria", "request": { "name": "Create a Shipping Discount Criteria", "description": { "content": "Creates a Shipping Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "632dcfa1-198c-46fe-a55c-f5f9e6e02cb7", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"criteria_id\": \"string\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a20028d1-e5bb-4640-81d5-456d1b5fa278", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1344855b-bae2-410e-a0be-ea10967a1a3c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba3840d-e47a-4036-a018-9e0e0df330c7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "245ae0b6-d616-4afe-88cf-069de7e449f6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f97c4e-b2b2-447b-95c3-258381abb1f1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7008a4a-ffff-4dff-a520-98eab0036990", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e8e7ae3-798d-4f8d-bd68-88d5a3052911", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ccf7a64-f897-44b4-a10d-ae940c51afe2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DATE_RANGE\",\n \"code\": \"SUMMER2024\",\n \"range_start_time\": \"2024-01-01T00:00:00Z\",\n \"range_end_time\": \"2024-12-31T23:59:59Z\",\n \"product_id\": \"string\",\n \"product_quantity_min\": 1,\n \"product_quantity_max\": 10,\n \"plan_id\": \"string\",\n \"subscription_quantity\": 1,\n \"total_amount\": 100,\n \"operator\": \"GREATER_THAN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4560b976-19d5-47aa-be67-8c4b5d21db8f", "name": "Retrieve a Shipping Discount", "request": { "name": "Retrieve a Shipping Discount", "description": { "content": "Retrieves a Shipping Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "932b1a57-1a5b-4a36-82c0-853c4b345173", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6004e7db-b0da-4d9e-b890-52ca462d4132", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d99f396a-c798-4228-b8e5-55cf06866734", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8440076e-e6dc-456f-8af2-2fd47e0a378d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddbf839e-c40b-4a8e-88e4-e35fc752be70", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b7d5326-4f43-47e6-8bd9-6867ea02f5fd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659f22cd-cf1c-4901-9267-bf0e12c3f15c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce560bac-7307-4323-ac36-4971c2a282af", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93861e6-b55f-4cad-84d5-f685d64c8c6f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "472ad41e-dc11-46b7-975c-0562bfdeeae7", "name": "Delete a Shipping Discount", "request": { "name": "Delete a Shipping Discount", "description": { "content": "Deletes a specified Shipping Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "6bf8fc57-3758-4b70-a823-0cf31bf291c7", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb4e2e85-120a-4c09-8d92-f3b74314cdef", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81bdc640-3c5b-41eb-8b6d-15bef06bfdd2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "511abed8-25ec-4fc3-beab-aebccbd2a718", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fe9654b-a68a-4ba0-a684-76892d2f2967", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d637393b-b9f2-4589-b319-c0f725fa4fcb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "548bf698-e095-4809-a56b-682cd30503db", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90d7ef6-5367-4ba0-b1ab-972b66e11977", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0b045a-7c9c-4ae3-9ee2-1db0b1f101b4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "410a697b-6de1-45ba-b222-11d3f2cb6daf", "name": "Update a Shipping Discount", "request": { "name": "Update a Shipping Discount", "description": { "content": "Updates a Shipping Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "criteria", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "375dd3b1-1dfe-4184-8847-c5afd18a2248", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e3d01f-5781-4e05-938c-2299586fa551", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b71dca20-c379-4221-9c7b-0031e67c2c87", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99c5769e-0448-4c8e-b846-202b1735f358", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0d7553-d44d-44f9-a737-2045b799cf14", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c3bcc5-34bf-4709-b26b-7bc8258acf21", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7cc7131-6a8d-48f0-ac71-4976b49007fd", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c197b492-d991-4519-92e5-7efcdd90fbfa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b2d0573-71a6-4192-8a2a-bf527eec51d3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccb22629-3332-4e0f-a650-5b7da8031a5b", "name": "Delete a Shipping Discount Criteria", "request": { "name": "Delete a Shipping Discount Criteria", "description": { "content": "Deletes a specified Shipping Discount Criteria", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2a7596d0-5d08-43ec-aa50-79739205a455", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80491d0e-5c54-4459-a71b-f3cc9be677bc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86937ba6-83c9-4cd4-9101-65dccc8c64b9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b300c430-62e7-4249-8670-b8ba176b12be", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c01ebc-f62f-48b9-a377-ad364a080c15", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f2a0c0f-a251-4ffd-b802-e442272e46df", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea40ec74-b141-4872-ba71-0818a3c76f9e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff17cb3e-5131-4f26-afda-d0ddb0af092f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4bf67f4-ed8d-43a0-a3de-d8480645c630", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id", "criteria", ":criteria_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "criteria_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dca942db-5044-4760-9e33-12dfa281e0e3", "name": "Subscription Plans", "description": { "content": "Subscription Plans endpoints.", "type": "text/plain" }, "item": [ { "id": "7406f6b0-f0e7-4105-9e45-145af6cc3dbc", "name": "List Subscription Plans", "request": { "name": "List Subscription Plans", "description": { "content": "Retrieves a list of Subscription Plans", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (Boolean) `active`: true or false\n- (BillingCycle) `cycle_type`: DAILY, WEEKLY, MONTHLY, YEARLY\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=active%3D%3Dtrue`\n- `filter=cycle_type%3D%3DDAILY`\n- `filter=active%3D%3Dfalse%3Bcycle_type%3D%3DWEEKLY`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `product_id`\n\nOne of the following directions:\n- `asc`\n- `desc`\n" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d30fd191-5194-4dc9-81db-154c555d9d3c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00e7e0c-3223-4e65-b5d6-831a663df52c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9c11100-fb33-4e24-baca-c9a60697dc71", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3f73460-f83c-45ac-83eb-e5a6d09c3565", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da61c6a-7506-48a8-a8a7-219c6c9b83e2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "569233cc-f6a6-43be-874e-56be5c53653d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f64e6e4d-1db0-4e10-93c6-3b860e3d7900", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64572b1-010d-4e8b-825a-0a733f48dfef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ba6c9ec-6ac0-4499-9577-f33eea53b7de", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "'-' can be used for a wildcard (/v2/products/-/subscriptions", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee779a2e-b2d6-4999-b27d-931c192fbf68", "name": "Create Subscription Plan", "request": { "name": "Create Subscription Plan", "description": { "content": "Creates a Subscription Plan", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7540ed54-dc2c-4ac0-a831-b4081dd2938c", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"frequency\": 1,\n \"active\": true,\n \"subscription_plan_name\": \"Premium Monthly\",\n \"cycle_type\": \"MONTHLY\",\n \"total_cycles\": 12,\n \"plan_price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"display_order_index\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f08a474d-c753-4e7b-9546-9a87f0af7f8d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4546ffb0-827f-4225-8ca3-3f22658555f1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b43732b8-c9f7-479d-a8e9-f1ceece2c1e8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "536c2755-5f8d-4b06-ada4-ad879a5331e5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a6888c-45bc-4892-8bd3-a43fd7b8a856", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e401115-0821-41a4-9ddc-49e360d38eaf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7821a8d0-7b4f-4925-ac3a-e9d4702b9905", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5f0c3e-d6d6-4092-8ea0-6d5715bab253", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03c42f65-3810-4b15-8d1d-7264f3faf97a", "name": "Get Subscription Plan", "request": { "name": "Get Subscription Plan", "description": { "content": "Retrieves a Subscription Plan", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "18bd8175-662f-4f8b-b433-7e46ae5391ee", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"frequency\": 1,\n \"active\": true,\n \"subscription_plan_name\": \"Premium Monthly\",\n \"cycle_type\": \"MONTHLY\",\n \"total_cycles\": 12,\n \"plan_price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"display_order_index\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5182e926-d816-49a1-84bf-e5a567e25988", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b5dbec-d37c-4743-aa78-4d5acc074bf6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1023d786-9443-40cc-95e4-052e2918ba88", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec11548d-f954-460d-8003-d6fc46f9ea7e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cd5595-acb3-437c-9e99-e2ba9a79a9ce", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af76b75-7f69-47e4-9efd-2a2a522962b6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9b88442-b348-45d0-8ac6-9cd7eee9bad9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce3e0684-ccb6-402f-9af0-81968b519d4c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adf49ae0-bcd1-4c46-8f35-fc3286379712", "name": "Delete Subscription Plan", "request": { "name": "Delete Subscription Plan", "description": { "content": "Deletes a Subscription Plan", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b027bc51-c30b-4ad4-ab08-636c154afa49", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4f16057-e74d-47e6-b768-dd66e3b66da7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "927d3971-c1a7-4c4a-b35b-ed94ac73cce8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc027afb-c4f5-4475-ba88-d17f8ab16b82", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa0dccaf-35ce-48c5-a2c9-2853f7be7b26", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea5292d-1bcc-4d60-8383-c5ce337a5810", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e93a35b-8d36-4e93-a632-623c4f8f0b4f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a0719d-9624-4a53-85c2-037b1285ea8d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d4d3443-bb1b-42a5-97c6-81a316f47626", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb812ce6-bde0-4590-908c-f050823d2583", "name": "Update Subscription Plan", "request": { "name": "Update Subscription Plan", "description": { "content": "Updates a Subscription Plan", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "allow_prorating", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "display_order_index", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "df145f6d-5e77-4367-8a55-937e3844eeb0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"frequency\": 1,\n \"active\": true,\n \"subscription_plan_name\": \"Premium Monthly\",\n \"cycle_type\": \"MONTHLY\",\n \"total_cycles\": 12,\n \"plan_price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"display_order_index\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a24a4a7-30be-4df4-a365-b1e2bbdc3da4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f12c6e7-a1e3-43d6-b2f5-6cf3881487f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0b9d114-389d-48af-9195-8c9c6a8cfa6b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05151bc-0c41-4cf0-9f73-7fbccafed9a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88432099-3e80-404b-8825-cc473e746b98", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f495a1d-557b-4cc8-8e59-09bb865cab2e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9e0b9d-9fb2-4546-b494-ec9a2a88212a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501f94ee-fe34-49a1-a9d5-cfe3fd789070", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "cycle_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "subscription_plan_id", "description": "(Required) subscription_plan_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cycle_type\": \"MONTHLY\",\n \"plan_price\": 10000,\n \"active\": true,\n \"frequency\": 1,\n \"allow_prorating\": false,\n \"display_order_index\": 0,\n \"total_cycles\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bf21e213-a66a-4dbb-b056-1fa750c4344a", "name": "Subscriptions", "description": { "content": "Subscriptions endpoints.", "type": "text/plain" }, "item": [ { "id": "ded26113-efd4-4ec6-9bb2-6642eeb04562", "name": "List Subscriptions", "request": { "name": "List Subscriptions", "description": { "content": "Retrieves a list of subscriptions using the specified search criteria.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `contact_id`\n- (String) `subscription_plan_id`\n- (String) `status`\n- (String) `id` - Allowable operators: \"==\", \"<=\", \"<\", \">=\", \">\", \"!=\"\n- (String) `billing_amount` - Allowable operators: \"==\", \"<=\", \"<\", \">=\", \">\", \"!=\"\n- (List[String]) `ids`\n- (List[String]) `subscription_plan_ids`\n\nCustom fields can be filtered by their field_name (case-insensitive, as returned\nby GET /v2/subscriptions/model). A standard field above takes precedence over a custom\nfield with the same name. The supported operators depend on the custom field's type:\n- Text-like fields (text, text area, name, email, phone, website, social security\n number) and single-value choice fields with text options (dropdown, radio,\n state): `==` only, with optional trailing wildcard (e.g. `_SubscriptionNote0%3D%3DValue%2A`)\n- Yes/No and drilldown fields: `==` only\n- Numeric fields (whole number, decimal, currency, percent, year, month, day of\n week, user): `==`, `>`, `<`, `>=`, `<=`\n- Date fields: `==`, `>`, `<`, `>=`, `<=` using full ISO 8601\n- Multi-select fields: `==` matches records that contain the given option\nCustom field filtering on non-indexed fields is supported but may be slower.\n\nYou will need to apply the `==` operator (or other supported operators), to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=contact_id%3D%3D123`\n- `filter=subscription_plan_id%3D%3D456`\n- `filter=status%3D%3DActive`\n- `filter=id%3E5`\n- `filter=billing_amount%3E%3D100`\n- `filter=ids%3D%3D1,10,4,24`\n- `filter=subscription_plan_ids%3D%3D10,20,30`\n- `filter=contact_id%3D%3D123%3Bstatus%3D%3DActive`\n\nCustom field examples (for custom fields with field_name `_SubscriptionNote0` and `_SubscriptionCount1`):\n- `filter=_SubscriptionNote0%3D%3DTest` (custom field exact match)\n- `filter=_SubscriptionNote0%3D%3DTest%2A` (custom field prefix wildcard)\n- `filter=_SubscriptionCount1%3E100` (custom field numeric comparison)\n- `filter=contact_id%3D%3D123%3B_SubscriptionNote0%3D%3DActive` (combined standard + custom field filter)\n\nFor fields which allow wildcard matching, you may use the * wildcard character (or its encoded form %2A) for case-insensitive partial matching on text fields. Example of a valid pattern of wildcard usage:\n- `field==foo*` finds anything in `field` that begins with `foo`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `contact_id`\n- `subscription_plan_id`\n- `modification_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c0d71721-3b0c-4804-9ef5-967d1ef187b1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e66a315-36fa-42e9-8bb2-7d119ff42657", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "187c31a8-d11e-4b55-9670-e6a3d21ecf96", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2bcf5c0-0fb7-4dad-a224-742b97bfe3da", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515e9db1-be9c-4351-8c07-7c764748aa5b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5213080e-fcfa-4e6c-bd21-b02a52d0f416", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9f3c44d-e350-4ee0-8d95-5d591bfb39d9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d209a970-d4d9-4ea0-918b-0185c54fe7d7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df48e1b6-bf84-4fc2-9916-be879fd9b801", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d263728b-2eb3-4834-94c2-225fddd00702", "name": "Create Subscription", "request": { "name": "Create Subscription", "description": { "content": "Creates a subscription with the specified product and product subscription id.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9bb9100-c730-45c9-ab4d-661fbab7b56b", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"start_date\": \"2024-05-21\",\n \"last_bill_date\": \"2024-05-21\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"merchant_account_id\": \"string\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"modification_time\": \"2025-06-15T10:30:00Z\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b2782f-5159-4303-a354-5544d7b738f7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a708c2e5-ab19-4d00-8502-305a0e4ed5b5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f4aaae-674e-41f2-9f16-24a3e1e57d24", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bfda4fb-d9a4-4189-914a-cff296883870", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e8646b0-d411-43dc-a6dc-0015a5288a65", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3851e6fd-13fc-4023-b244-584001b81997", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0c0ce1d-3d69-468b-93df-469a12c9f5c6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24656654-daad-4750-bc88-600ff160c258", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"start_date\": \"2024-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"allow_duplicate\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "998f4375-a2e7-4676-b1f7-83162b51a722", "name": "Invoice a Subscription", "request": { "name": "Invoice a Subscription", "description": { "content": "Generates invoices from all cycles of a subscription that are due. Returns the most recently billed invoice.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "29eaafbf-6349-48fb-a1b6-65c78ee90d3c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Online Order #1234\",\n \"status\": \"PAID\",\n \"total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"contact\": {\n \"id\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n }\n },\n \"notes\": \"Customer requested gift wrapping\",\n \"terms\": \"Net 30\",\n \"order_type\": \"ONLINE\",\n \"source_type\": \"API\",\n \"creation_time\": \"2024-05-21T14:30:00Z\",\n \"modification_time\": \"2024-05-21T14:30:00Z\",\n \"order_time\": \"2024-05-21T14:30:00Z\",\n \"lead_affiliate_id\": \"string\",\n \"sales_affiliate_id\": \"string\",\n \"total_paid\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"total_due\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"shipping_information\": {\n \"id\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"invoice_to_company\": {\n \"value\": \"\"\n }\n },\n \"refund_total\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"allow_payment\": true,\n \"allow_paypal\": false,\n \"order_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"payment_plan\": {\n \"days_between_payments\": {\n \"value\": \"\"\n },\n \"number_of_payments\": {\n \"value\": \"\"\n },\n \"plan_start_date\": {\n \"value\": \"\"\n },\n \"auto_charge\": {\n \"value\": \"\"\n },\n \"max_charge_attempts\": {\n \"value\": \"\"\n },\n \"days_between_retries\": {\n \"value\": \"\"\n },\n \"payment_method_id\": {\n \"value\": \"\"\n },\n \"initial_payment_amount\": {\n \"value\": \"\"\n },\n \"initial_payment_percent\": {\n \"value\": \"\"\n },\n \"initial_payment_date\": {\n \"value\": \"\"\n },\n \"payment_plan_items\": {\n \"value\": \"\"\n }\n },\n \"invoice_number\": \"string\",\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"credit_status\": \"APPROVED\",\n \"promo_code\": \"SUMMER20\",\n \"refund_status\": \"NONE\",\n \"synced\": true,\n \"invoice_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ],\n \"sent_time\": \"2024-05-21T14:30:00Z\",\n \"due_time\": \"2024-06-20T14:30:00Z\",\n \"external_create_user\": \"user@example.com\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67738a32-c8db-4e7b-8b2e-00dd2710ba7a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecdf29a4-0cad-4b94-b7b9-dfff7a026e1f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58936f73-1362-4c04-9344-ef3972914a72", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4dfe252-fd9c-4191-a7f1-f3d8732278b3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "263e33d9-82f1-40a3-9dba-2f3cb632ba99", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1267a785-c20e-4fa6-9995-e35b3e563e42", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c427e8a-e756-42dc-abec-5c991c946ee4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "695edf7b-ab3b-4461-83c3-9e36a3402e1f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53975648-3e67-4d99-90e1-54abe75e2b0d", "name": "Cancel Subscription", "request": { "name": "Cancel Subscription", "description": { "content": "Cancels the specified subscription", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a713f3e4-9071-477c-a860-b179b83f16e2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4273032f-3328-4a7d-b2b1-4c0585b83791", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a815d600-79ef-4779-b82e-6b7f46de16f6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c15b779-200c-4eab-9d31-ba6c94dcb993", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c6db966-4e9a-4d87-94c0-27cbb37fcbd3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de0c944f-5571-470d-9981-f6a81736b70c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "748ba4e8-d277-4382-be22-89d79fb360e3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d21b93-447c-4159-9dc0-c9883bdeee79", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad830f4-a692-4bd5-afc6-f7b2c0ebb42f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "{{subscription_id}}:deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer request\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a02bf1d4-017c-428e-aed7-5545064c66e0", "name": "Create a Subscription Custom Field", "request": { "name": "Create a Subscription Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Subscription object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "387542dc-8a9d-401c-a106-e53e8008bc65", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "835a3dd3-70a3-4036-b8cf-b4f86fbe17bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4b1f76-dd92-4df0-97aa-0fefea36f5be", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76591066-3a35-40a1-af66-6ffd4a4f3a72", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b5e1fb-09b9-4364-8c36-5c100c561893", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03469334-3ef3-4b94-9f17-3ba7e485e5de", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d371497-6973-47b0-b4b1-3a24d9e9a520", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6e8623e-c7b9-456b-b8c9-e8190628b008", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2507873b-e403-48bd-a95c-c954dba55c92", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d28e3d5e-0b6e-4ce1-942f-b0a24dd000db", "name": "List Subscription Custom Field Tabs", "request": { "name": "List Subscription Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Subscription record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d453ba07-e04e-47ad-a62d-46f9dfa3259c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3ccb58-d82c-41ae-806e-b18385b70bea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e361bbb7-9c34-4793-be0b-33816b4803f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69bb5970-2bc3-4f58-a60f-16182c177e6f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e275bd59-a748-4f0b-a06d-93ab1b6ad961", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f4211a-a575-4a46-8efb-4e4707f2cb52", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dff6887a-3763-49a1-b4a6-613b54d2ae11", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "920f45f5-16e5-48bd-8ce0-7e0edb4d74a2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cc92ffa-8a5f-48dc-908a-8e1934a6959f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cdfa63c-cbaa-48fe-ade3-d06422b0131f", "name": "Create a Subscription Custom Field Tab", "request": { "name": "Create a Subscription Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Subscription record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0044504a-898a-4458-90e9-4421ded6fddc", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c725c03-2dff-48fa-a9c8-ff6a4c01a681", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a915c50c-0bec-4290-932d-1a5cfcb971b8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3747a64e-4896-4ff9-a222-c764f3a11f25", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98eac2c0-d695-48fc-b12b-a4c3a0f6a418", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94af518e-889d-4fae-a3a5-0899e97f80fe", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429e9862-66f0-4360-bbb5-9209a2e42b0a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcbc5165-5c67-4c30-906a-4c498440c3d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6d9819d-b5b5-4e38-b0e2-8e22ec50a143", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14283af1-f85a-4811-a197-0b777edb9a63", "name": "List Subscription Custom Field Groups", "request": { "name": "List Subscription Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Subscription record type. Optionally filter by tab_id to scope to a specific tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6979a40d-1a96-4d87-b5e9-d1fa5effb2a5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5a7aaea-8169-4588-8b77-25c3bfd68aef", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2480b488-3c04-444f-911a-80baf6489a6a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4accf2ac-9e4e-46d9-af84-a7d0fd5ab82c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba9c32a7-0fa8-4114-9feb-98cd187d9bf5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7664cbf-f133-474a-93f0-b4f8a27eb855", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b4c0f9a-19f0-43d3-964d-bd87c03a321f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2155da34-da28-4684-8a1d-1788c58fd698", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6170774-0015-416c-8158-6b8baa8be8a3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9877c311-76c1-4522-9cf4-2189d4f10ea3", "name": "Create a Subscription Custom Field Group", "request": { "name": "Create a Subscription Custom Field Group", "description": { "content": "Creates a new custom field group for the Subscription record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "754d3cc0-ab00-4246-bffb-94f0433d2376", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be2f4f7-fff5-4c47-b738-67af8101d8c6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3c85b8e-fc50-4e40-8c2c-11f0c1c2bdca", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24f208a-5840-4f7d-8753-9eeed5389a6d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ad7de4-ee35-41fb-8e0e-5634a06bfadc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c085b96-4202-41c5-bc54-ead4c0e88102", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652f080a-a2e7-40ab-81f4-0f20513c7aec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "714c8be3-bb93-44a5-9ba2-099918626ae7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155c253e-e10d-4bc5-b982-fd807b5e2f72", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b5520f9-5d45-4a8b-911d-455393596fec", "name": "Retrieve a Subscription", "request": { "name": "Retrieve a Subscription", "description": { "content": "Retrieves a single subscription", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4e0df94d-ba34-402c-9b85-8bee2be89521", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"start_date\": \"2024-05-21\",\n \"last_bill_date\": \"2024-05-21\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"merchant_account_id\": \"string\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"modification_time\": \"2025-06-15T10:30:00Z\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e962878e-090d-44f4-b4ff-9218aae01541", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f3c8f0-52f4-47e7-a3f5-9d1fccfb6030", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d03c34a4-4578-4160-8a02-43169455ec3c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17f0e7dd-27ce-4c8e-8a8c-d7b5f614f65c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4169ec51-f956-450a-9b2c-ef11fa6fc4b9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb7eeb5-d876-4e22-8d23-0f79df3cd151", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd22bd7-d446-47d1-b9cc-acf0cafde392", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71018a76-20b0-4699-90d1-6e239c2598dd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40338bf3-c15e-4b64-99fb-9ff3d2f40df5", "name": "Update a Subscription", "request": { "name": "Update a Subscription", "description": { "content": "Updates a Subscription", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "max_charge_attempts", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "reason_stopped", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ac8c5fdc-7808-49f7-8662-394b3b5206bb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"product_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"start_date\": \"2024-05-21\",\n \"last_bill_date\": \"2024-05-21\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"merchant_account_id\": \"string\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"modification_time\": \"2025-06-15T10:30:00Z\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12469c25-8bc0-4197-a626-d1ec0c0cedf5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff1db081-348e-4cc0-888a-c0331296c67f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55650a8b-f25a-4254-80fc-fb9b16c59682", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca7d04c-d764-4c9b-9494-d2cd67f2b3a4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c03541a0-e61a-4c0c-8f74-b3db5f0978a4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7d3871e-6ae0-47b3-b459-3f519db307ea", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0e43064-e00a-4410-bb54-32f89f30e147", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b26b64-f2de-4ef3-9463-998b8b56adec", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "reason_stopped" }, { "key": "update_mask", "value": "next_bill_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"quantity\": 1,\n \"active\": true,\n \"contact_id\": \"string\",\n \"subscription_plan_id\": \"string\",\n \"billing_amount\": 10000,\n \"auto_charge\": true,\n \"max_charge_attempts\": 3,\n \"days_between_retries\": 5,\n \"billing_frequency\": 30,\n \"billing_cycle\": \"MONTH\",\n \"next_bill_date\": \"2024-06-21\",\n \"end_date\": \"2025-05-21\",\n \"payment_method_id\": \"string\",\n \"allow_tax\": false,\n \"lead_affiliate_id\": \"string\",\n \"sale_affiliate_id\": \"string\",\n \"shipping_address\": {\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n }\n },\n \"promo_code\": \"PROMO123\",\n \"shipping_option_id\": \"string\",\n \"reason_stopped\": \"Customer requested cancellation\",\n \"custom_fields\": [\n {\n \"content\": \"VIP\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e662643-e7bd-47d7-b339-8cf594b45e38", "name": "Delete a Subscription Custom Field", "request": { "name": "Delete a Subscription Custom Field", "description": { "content": "Deletes a custom field from the Subscription object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "3c29e5eb-bd71-4909-8139-d761bce31ce7", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "675ee55b-5f1c-4010-b11a-9dedeed31ca4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4ce1c4-dd1d-4710-851e-8b62e4ed8111", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55f27ea5-c05e-4c75-a672-86b1ed7c8adc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30fa43d-34e2-49a3-88a0-27e07f4a7619", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01b868fe-2fd6-4145-b236-a9ab8911f678", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d34a7b8-d4a0-4ceb-b71d-0e2a3d67460d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a1f7570-052d-4f28-a904-55a2dbfff979", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec5914dc-7c51-4e1d-8172-f038244b6fd0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c860e780-b63f-4977-bbef-5e3c085f6927", "name": "Update a Subscription Custom Field", "request": { "name": "Update a Subscription Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Subscription object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f6314a7f-a28f-40b9-a2f1-c63d7c95e292", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57fce756-ddc9-42e7-82a8-a8e035342bfc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d1ac62-23c4-4da4-938b-ec6c0fea7eeb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e98ba30c-6f2f-4771-a6a8-47bb6e3504f1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a348a6af-e65d-4b8e-b3ab-6559e7c71379", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8ef79ba-a880-4a18-a71d-3a74399e69c3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd41b25a-740a-4712-a67a-15eab624a37c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8200e086-a6d3-4af3-8c5b-2e219e9e74c6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49775adc-4c05-489c-a953-d297ccaa4274", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b571db31-bc00-404c-8e32-26da0df0591c", "name": "Retrieve a Subscription Custom Field Tab", "request": { "name": "Retrieve a Subscription Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Subscription record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "add33627-a734-4112-b379-c5867a0e95a2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0485fbb-63b1-46da-9c16-89f662acbda2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23806fa1-782a-4d87-854a-54c2852a1324", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58fd5586-fef4-4401-b682-13b30bc29a34", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c545c09-8656-461d-8225-e932649d2c8c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd74ebe1-72d2-40b9-951b-8822bcf08c33", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a43aff9d-9ce1-47eb-a7c6-36c01ab766af", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22014477-f662-4ab7-b0b2-5b1a8d8e3a5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b4e6f3-09fd-4111-ad1d-f2901891de87", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfaedf27-6d6f-4031-8cf7-ea979ca9889d", "name": "Delete a Subscription Custom Field Tab", "request": { "name": "Delete a Subscription Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f495844b-e5c1-4ace-8208-0d875d578240", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c94948a3-1cb7-44b7-8c99-82aebdc8e367", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da2f7337-0908-47b9-b843-cfa8ad49354c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61705d8-ffe0-478d-9c13-1d53b0e7464f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "664cc161-ffc8-4729-bc15-b0c2e3525ab3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c61fe463-99f0-4c5c-b9a4-1b54468b9585", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91915bf9-9208-41a6-a40e-dcb6e3d0d4ab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca9bb4ac-0f80-48ba-bfe9-cca8ff30a0bd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5724cfe6-f049-4a7e-a7d7-6f0618e96fee", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "621b40bb-e345-400d-b6d3-de4088da4372", "name": "Update a Subscription Custom Field Tab", "request": { "name": "Update a Subscription Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "223a28a2-4830-4b15-a3f6-afc4b03ea320", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1871efa0-390f-4dd0-b995-bc5b540f038c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ebd1972-d88a-4316-8b07-9502b808707f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c2ecd4-faf5-44be-a925-3e595d971540", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775fd87c-3a6c-4d00-96f1-0af231c2ff32", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005cb259-3f54-43a5-aad0-5659f94ee51c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b623bc6b-26e1-46b1-9702-e66e85144c2d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5874857a-3603-4964-9f7f-276684caf0ef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1fd9932-aa6c-439b-969a-37b8fcf475bb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01c225fe-ede5-421b-b50f-129d2a337639", "name": "Retrieve a Subscription Custom Field Group", "request": { "name": "Retrieve a Subscription Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Subscription record type.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ce086723-6339-43ee-a6bc-b668f7435925", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd15642e-254f-421c-9dd4-31c1f10a76a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88e074aa-5642-4ec5-aa4b-f2fd77cab194", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa408b0f-12bd-42df-9421-299aa9bc8c57", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01e014f8-122f-47ee-858a-bb30b923e967", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90cc9b8a-823f-422d-8771-0b5ef0382a06", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69f64937-1874-4f87-833b-774fdee2ec99", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90fccc2-88f7-4efa-ae96-423cf89db636", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd36fa9-3c26-4e56-804c-b8216754aa67", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f30ece41-73de-4a66-9fa5-90e6df5d78fd", "name": "Delete a Subscription Custom Field Group", "request": { "name": "Delete a Subscription Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4cb0b251-391e-4a58-8763-04695fa796ec", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e41a5d9-731b-4f49-8994-c41406ff8f01", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d897f548-8f0f-46d8-9685-fa53f1dcb3f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd99f45a-1596-45dd-bd54-01399275d354", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d6309df-312c-4ec8-a089-7f4e947e383b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded6e247-ace7-47d3-b988-097e67bd856d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9f9b37f-907b-4164-9441-2e744150ff0f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9566fd8e-2df6-4b7e-a463-8478147707c3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787c3458-2516-44a7-9628-a3c4a0becfeb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f93a12d9-5a65-4e6e-aec4-e929035132c0", "name": "Update a Subscription Custom Field Group", "request": { "name": "Update a Subscription Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "25c5bde6-0ac2-49ec-8932-0eb627191da5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ae43c53-5898-44ba-b95c-47abc536c389", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e90039f-c401-47d8-95f0-25864be0e047", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799f752f-17c2-41c9-af29-25b99748de40", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4a14169-f548-41ba-8fca-21b597e26ff3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cdda58d-46c0-4e03-9f7d-8c0bb6417ac3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e679bad-e1e3-4d61-8fb5-4cffc0c9b0ab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae44e5af-9cbd-44c3-b0b0-d765797a6693", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15436fd2-fcd7-41af-a0b0-379e5b8e0380", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d90c4d4b-69ee-44b9-b10f-cbd7bc0e0de8", "name": "Retrieve Subscription Custom Field Model", "request": { "name": "Retrieve Subscription Custom Field Model", "description": { "content": "Get the custom fields for the Subscription object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f0f7c435-ac66-491f-b3f4-5f78bb5708db", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cca32b-c9f2-49a9-8da7-1788d76df1fc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e153afe7-9f51-437d-a61b-b2ea8d8e9e66", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f744170a-abd8-487e-9df9-6a14daa4f3c3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb505682-b5cf-4b3d-aca4-2eda10b60918", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bde16df-fe20-4762-9318-8bf2a788226a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9716412e-3be2-41a0-acd5-d6878b6a9365", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450490c4-69ee-48bd-84dd-4634232c711c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ba851e-543b-4924-b6f1-f5216b2a1f7d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7b24c553-b871-4688-b828-508ac6cd039e", "name": "Tags", "description": { "content": "Tags endpoints.", "type": "text/plain" }, "item": [ { "id": "5d2ddc7e-57f9-4aa9-bb9c-624e88ec4ac0", "name": "List Tags", "request": { "name": "List Tags", "description": { "content": "Retrieves a list of Tags defined in the application\nTo search for `null` or empty fields use `filter==NONE`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n\n- (String) `name`\n- (String) `description`\n- (String) `category_id`\n- (String) `tag_ids`\n- (String) `since_create_time`\n- (String) `until_create_time`\n- (String) `since_update_time`\n- (String) `until_update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. If NONE is passed in for `category_id` or `description`, it will check\nfor the non-existence of that field. For the filters listed above, here are some examples:\n\n- `filter=name%3D%3Dmy-tag`\n- `filter=category_id%3D%3DNONE`\n- `filter=description%3D%3DNONE`\n- `filter=tag_ids%3D%3D1,2,3`\n- `filter=since_create_time%3D%3D2024-12-22T01:00:00.000Z;until_create_time%3D%3D2025-01-01T00:00:00.000Z;`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n\n- `name`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a1c317bb-e32d-4000-9403-022fe8670891", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7fa9c2d-b5d0-48cd-8802-ce3a876c065b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2b9b33-d49e-4cae-8efd-f113e8f548ae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bcbdf97-f146-44fd-9d14-b6d50b2c93fe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d64752fb-89c0-4926-9da5-42034569e828", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e94fb28-6e45-4c51-b350-aec99cb60728", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef30450b-8323-4db5-8f8a-821ea0846df2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6672b330-c540-4503-a8c8-3e6f8f39a39c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcdbf44a-fc6c-4adc-a1a9-f037d91648c5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a42738b7-2bba-450a-968d-da3f6b7fbd46", "name": "Create Tag", "request": { "name": "Create Tag", "description": { "content": "Creates a new Tag", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a7877138-7532-46d7-8a03-5d3e78f366e1", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e39fdd8-157c-444b-8e4e-8fae7c503da3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69f83767-3e4b-4f83-bafc-c133c41cfa43", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38eb752e-fae0-4bb6-a3c6-727bd4bcb4ea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e7dcb27-a532-4907-80fd-9d9f040bd231", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b7ee09-a20a-41c8-8f5a-5702b73f5db7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f726423-652b-433e-98da-aaf692f228a8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0f88de-b1ce-47ee-bbce-091b2ab43381", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e42c856-fd69-4834-9a35-830f10262695", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18802f45-1217-4933-9fee-5321eeb7ea88", "name": "Remove Tags", "request": { "name": "Remove Tags", "description": { "content": "Removes a Tag from a list of Contacts.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9682fd3f-f6fd-452f-8b4f-e6dbc09c6eec", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0dfafd15-0738-4b06-ba4d-02aeddcd0d11", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7601bf50-fc8d-44f9-b9f0-0a1f0c28a5ce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38de8368-b4bb-41de-b749-9d78a8942f5f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21fac9dd-e51c-42f0-ad9d-3b300c53177f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc6c61ee-dfe7-464a-a59e-3fd7da00ad4d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3bd079c-fc5f-4c8f-a963-65a86023f458", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ebeee84-97bb-42b4-bc7f-a27dd155e32f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd191ae9-e480-460f-a56e-6a4160f23005", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:removeTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f7a4cf6-1527-4344-a049-634e15c8f022", "name": "Apply Tag", "request": { "name": "Apply Tag", "description": { "content": "Applies a Tag to a list of Contacts.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "964b1b53-5e8d-4891-9c51-40f41e913956", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e89c52a-83d8-401f-aafc-5c6627c21c7a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1fd0a6-92fa-4abb-aee9-26a6ced12cac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb413b36-23c0-472b-b446-00ec2e3b6257", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "630fadf2-e93a-4e3b-a021-823a8ad3f8b0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0dd248e-11d7-4b12-b403-7238d2fe14f6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9b248f-ceb1-4ce1-baf4-593ca3c256ac", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326a858e-07a2-4f47-b14c-6d35a5c3d902", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27871e14-34c6-47dc-816c-5009bdf105ca", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8e9659d-11bb-47b1-8e72-03e3339fe532", "name": "List Tag Categories", "request": { "name": "List Tag Categories", "description": { "content": "Retrieves a list of defined Tag Categories\nTo search for `null` or empty fields use `filter==NONE`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `description`\n- (String) `since_create_time`\n- (String) `until_create_time`\n- (String) `since_update_time`\n- (String) `until_update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. If NONE is passed in for `name` or `description`, it will check for the\nnon-existence of that field. For the filters listed above, here are some examples:\n- `filter=name%3D%3Dmy-tag-category`\n- `filter=description%3D%3DNONE`\n- `filter=since_create_time%3D%3D2024-12-22T01:00:00.000Z;until_create_time%3D%3D2025-01-01T00:00:00.000Z;`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c067d88f-05cb-4a42-ba1d-50f9ce5c4aa6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tag_categories\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab96e4b-c1ea-4371-a2bc-f38a56bc42c0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adc0f4a1-8934-4f7e-b92b-ba31ca12688a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44cee392-e530-4e04-a85d-085731ec260c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0d2386-d409-4f42-a0e7-a4ef9db1e058", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c77e778d-0c09-4b94-8d31-531f410e4b35", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6effbfd2-e06f-4d4d-ba1d-291b4d996e86", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41d8755c-d5d6-4b3c-9d29-b51b48970a00", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee6e0a5-b845-43f8-9466-5279cd359fdd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63b6e31b-48ad-44ce-8b01-b434028a7788", "name": "Create Tag Category", "request": { "name": "Create Tag Category", "description": { "content": "Creates a new Tag Category.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "124ab049-d2dd-4ba0-955d-8fbb07d24542", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b168626c-2736-4394-8bbc-28e4e2e08495", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72c44037-88e4-4c5d-9a48-72e4ec6fba6f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750e1450-f85f-4822-84e6-532a75463eb5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bad6411b-2817-4e3c-bafb-6b7fec90fa60", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37f94b26-11a1-4b8d-8d74-b13e18973529", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5efb14a0-e335-4f8b-bfb0-500e07b0d6e5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc341d10-08d2-4945-9b42-1abdb0997bb8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614c2c32-70f3-402a-842d-5635bbf4154e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6b967e3-693d-421d-8fba-d5bbba3938af", "name": "Retrieve a Tag", "request": { "name": "Retrieve a Tag", "description": { "content": "Retrieves information about the specified Tag", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "299bb1ba-3134-4da0-9d78-b049fe515ce5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f15e4b67-2e32-4913-91f1-69232df2de07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d300e7c4-9466-4b3c-a9ba-df206f33d72b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "666dcd71-54fe-45cc-a3d3-eb0e6d5ede3e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf649c10-7fa1-490f-99f9-333ed2c91540", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "809d8d2f-7838-4443-9956-3a7324a78394", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1b4bdb5-05a8-4f6b-9f16-104c4f430822", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ed253e-7bb8-4364-a324-78a31214ac8f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f98785c5-ce45-4e66-ae5f-87ac9f5c1f49", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47cbaa53-d695-4ec4-a923-1269f5413acc", "name": "Delete Tag", "request": { "name": "Delete Tag", "description": { "content": "Deletes a Tag.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c5308b40-004f-4226-9a81-edf4c92d85fa", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ac43d61-7456-4629-b580-50f6059ff1a5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfee77c-aa2b-4390-9555-5bec43cc5295", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da456b77-4b04-4657-a2c6-a9a12c7e6a4d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902d59ae-90a9-4b97-badc-cf8bd5105719", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "975c483c-29e3-41dd-a151-6c30fa1e21a3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7925a314-26ca-43df-ac15-a89ca2513530", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed92ea6a-5f9b-4e0f-99f1-17b043da3748", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac70e2fd-cacc-4f2e-9694-4c7d5b5f4568", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0efca190-636b-48a7-995f-5a2560b32c42", "name": "Update a Tag", "request": { "name": "Update a Tag", "description": { "content": "Updates a Tag with only the values provided in the request", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "category", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c990b78b-cab9-4a3f-9b22-9f2b6d9e1abd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3fcb7d5-e8ce-4e4e-83d7-60793c9b9145", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a6d019-2bc5-44fc-9667-58b273ea4dae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a475833b-774f-4de7-a013-39b63cb89da9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a316202c-db81-47da-b336-1d5e0c769ebb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dcf51bd-1b48-46df-91f5-d77664dbf2bc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d3f2fb-9697-4ff6-8cbf-9c2b25485ecc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3e4bae7-27dc-4cdd-a62c-0a7c8e8f073c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac65b42b-151c-4906-993d-eb28e20fd559", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7048131d-64e5-4751-8de4-0fdfc641455c", "name": "Retrieve a Tag Category", "request": { "name": "Retrieve a Tag Category", "description": { "content": "Returns information about the specified Tag Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ea537043-96f1-4e2a-855a-21423168cea9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "823d4cf2-9274-4237-b5f1-57c472351bfe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8902f07d-7826-4fef-aef5-ce1c0bf22514", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6f8aad0-bd6e-4dec-84bd-b242193bf465", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138a37ec-ca3c-4836-8344-4f237d290dde", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ebcc72b-c2a9-4d95-91a7-d4413ad962a1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c834c634-1ff7-47a7-be63-cb50058cd25c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65dcc4ad-9626-4d70-846a-624623679cd5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fc71060-0b44-456f-94cd-1081a3cf8b39", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5804595b-b705-454e-bf41-156ba401435d", "name": "Delete Tag Category", "request": { "name": "Delete Tag Category", "description": { "content": "Deletes the specified Tag Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "d9979400-3aee-432f-acb1-7cb6c4eb7c4e", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b734726-9224-4f27-9c3e-65caabde7d76", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6ae77e1-4d8c-4be8-aa5c-aabb6cd8bc68", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7026250c-28e0-4c75-9e2f-9dc3692c9075", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdda4519-3f28-4748-979e-853c79e0adb0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952d2933-ad9d-454e-b4d1-21f866fd75c3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bc9eebb-d5f2-4c6c-a6f6-b2e57567a1af", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "202ae536-e2bf-4565-80f0-10ef72b4228e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16ea9a74-7294-46fd-a4fa-ed606811841b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aaabc32-5e74-4f0c-8f34-2acaec7f453e", "name": "Update a Tag Category", "request": { "name": "Update a Tag Category", "description": { "content": "Updates a Tag Category with only the values provided in the request", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d70ecf58-513d-4e4e-a3e0-5969c1a57b63", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf5e8f9-a01f-4dcb-9f9b-8c91d1038812", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7c4a263-7889-4522-936a-230299db33f0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad10406-d6f4-4be9-b0e0-88d674355650", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4169a3-c8db-4481-8591-e173720814f0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4563ab51-e0bd-4814-aab5-027f6a56f9d9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46e16519-cc6c-4593-ab2d-37ae2f812d1e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc4d5bb7-482f-4db8-9485-ab7de5f858ca", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "611c502d-2f62-4c91-9e97-b3cd70957fd2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1883cae3-261b-43cb-88f8-58b6fef74964", "name": "List Tagged Contacts", "request": { "name": "List Tagged Contacts", "description": { "content": "Retrieves a list of Contacts with the specified Tag\nTo search for `null` or empty fields use `filter==NONE`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `given_name`\n- (String) `family_name`\n- (String) `email`\n- (String) `since_applied_time`\n- (String) `until_applied_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. If NONE is passed in for `email`, `given_name`, or `family_name`, it\nwill check for the non-existence of that field. For the filters listed above, here are some examples:\n- `filter=given_name%3D%3DJohn`\n- `filter=family_name%3D%3DSmith`\n- `filter=email%3D%3DNONE`\n- `filter=since_applied_time%3D%3D2025-04-16T20:33:02.321Z;until_applied_time%3D%3D2025-08-16T20:33:02.321Z;`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `given_name`\n- `family_name`\n- `email`\n- `applied_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c5d11582-9ac6-40e9-8bbc-187064194a40", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "243016f9-7a1b-48d2-b3eb-f3cf2f3d5191", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2598bca8-62dc-420f-9385-434255f31c9f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb912584-0321-4325-9550-e750e83d2279", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a415b36e-6881-453a-ae9b-eb7d11b677d0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f2b6544-23e7-4335-ae71-3438f4c1acd5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "157e1a9f-41b5-4dda-8111-7916721ba319", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e82887-e0be-44d1-9a14-fb50cd94300b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53eb168e-39d0-4f98-a1a8-69f7e086700d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6cc01ef-b1f7-4fe2-889b-5102ba1e75c7", "name": "List Tagged Companies", "request": { "name": "List Tagged Companies", "description": { "content": "Retrieves a list of Companies that have the given Tag applied.\nTo search for `null` or empty fields use `filter==NONE`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `company_name`\n- (String) `email`\n- (String) `since_applied_time`\n- (String) `until_applied_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. If NONE is passed in for `email`, it\nwill check for the non-existence of that field. For the filters listed above, here are some examples:\n- `filter=company_name%3D%3DCompany`\n- `filter=email%3D%3Dtest@gmail.com`\n- `filter=since_applied_time%3D%3D2025-04-16T20:33:02.321Z;until_applied_time%3D%3D2025-08-16T20:33:02.321Z;`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `company_name`\n- `email`\n- `applied_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "97725ed6-aac6-4f7c-8863-4b6b8b4ad4b9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tagged_companies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d783c98e-db44-4538-95e2-6f648f777d98", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecc7be89-c0e1-4ed4-828b-6d7654bc3cc2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b27d01a-4688-4801-857e-b1f297ac1cd6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2fefcb5-0b94-4f3a-9328-0bc766cc1730", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9471ef-99b6-424a-ab5d-2c679973c374", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a304a25e-e4e1-4c4e-9588-6dbfc4ad3689", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9673eccc-4e3b-4a53-b10f-bb95508bf734", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a25fe6-abe7-4fca-a145-d3f19ebd4a5c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "companies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c0a7f78c-d413-4b54-955e-6c1f5a398597", "name": "Task", "description": { "content": "Task endpoints.", "type": "text/plain" }, "item": [ { "id": "be1637cc-3be2-4cee-b1b3-fe2293db5aa4", "name": "List Tasks", "request": { "name": "List Tasks", "description": { "content": "Retrieves a list of tasks based on the provided filter. Tasks which are not assigned to a User may be queried with user_id==UNASSIGNED.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `contact_id`\n- (String) `has_due_date`\n- (String) `is_completed`\n- (String) `user_id`\n- (String) `opportunity_id`\n- (String) `task_ids`\n- (String) `priority` — one of `CRITICAL`, `ESSENTIAL`, `NONESSENTIAL`\n- (String) `since_time`\n- (String) `until_time`\n- (String) `id` — supports `==`, `>`, `<`, `>=`, `<=`\n- (String) `title` — supports prefix wildcard (`title==Foo*`)\n\nOperators must be URL-encoded (`==` → `%3D%3D`, `>` → `%3E`, `<` → `%3C`).\nFor the filters listed above, here are some examples:\n- `filter=contact_id%3D%3D123`\n- `filter=has_due_date%3D%3Dtrue`\n- `filter=is_completed%3D%3Dtrue`\n- `filter=user_id%3D%3D321`\n- `filter=opportunity_id%3D%3D321`\n- `filter=task_ids%3D%3D1,2,3`\n- `filter=priority%3D%3DCRITICAL`\n- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`\n- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z;`\n- `filter=id%3E5` (id > 5)\n- `filter=id%3C%3D100` (id <= 100)\n- `filter=title%3D%3DFollow%2A` (title starts with \"Follow\")\n\n**Custom fields:** tasks may also be filtered by any custom field defined on the Task record, referenced by its field name (e.g. `filter=cf_priority%3D%3D10`). Both indexed and non-indexed custom fields are filterable. Operators must be URL-encoded, same as the standard fields above. The supported operator and value depend on the field's data type:\n- Text-like fields (Text, Text Area, Name, Email, Website, Phone, Social Security Number) and choice fields with text options (Dropdown, Radio, State) — equals (`==`) and prefix wildcard (e.g. `cf_company%3D%3DAcme%2A`)\n- Numeric fields (Whole Number, Decimal, Currency, Percent, Year, Month, Day of Week, User) — equals and comparison (`==`, `>`, `<`, `>=`, `<=`)\n- Date and Date/Time fields — equals and comparison; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `cf_renewDate%3C%3D2026-01-01T00:00:00.000Z`). Date-only values such as `2026-01-01` are rejected\n- Yes/No fields — equals only, value `0` (No) or `1` (Yes)\n- Drilldown fields — equals only, integer value\n- Multi-select fields (List Box, User List Box) — equals only, matched as a contains search over the stored selections (e.g. `cf_tags%3D%3Dred`)\nA custom field that does not exist, an operator unsupported for the field's type, or a value that does not match the field's type returns `400 Bad Request`.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `id`\n- `create_time`\n- `due_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1116d0c4-8da9-4afb-b977-bbe00d5e0503", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tasks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aaec61c-df6a-4619-b9a1-25ab0acdfc14", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a97179b-4b18-4262-a988-f6a7af4c4278", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1df61a1f-fb98-41ad-a460-1b0aff75cb96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ad6b0c1-af1f-47b1-8758-9a4192f3e4e3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e550bb8-0666-4091-aee4-c0a8d4e5756b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21ac6189-6956-45b7-926e-c81dfdca7aab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b2ac521-b51d-49a5-b55d-bae11df3d717", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb94025-8c10-4aba-8802-4d4bacdd6da4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" }, { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c54255ac-85dd-4b79-9c36-19e03a549dfc", "name": "Create a Task", "request": { "name": "Create a Task", "description": { "content": "Creates a new task as the authenticated user.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 2880,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ac1d736-5085-4d77-bb73-1f37175858ad", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review and respond to client feedback.\",\n \"type\": \"CALL\",\n \"priority\": \"CRITICAL\",\n \"completed\": false,\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"modification_time\": \"2024-03-15T10:30:00Z\",\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"last_updated_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53da9199-f65e-47f3-ac1f-89fdc8c86357", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89299f2-9c92-4b6a-9c1d-12bf89a72827", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "731ebe52-7e3c-4643-a4b3-2d3c7c07aef4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59240559-88e9-4bb1-85e6-320b1f27c586", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f491e4a9-891c-4e60-be98-1c3112145200", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f27bd90-544f-4387-b67f-54563679f8de", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e3bf880-10bb-48b7-a2be-778573954472", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "300b2abc-aeb8-4e9a-9009-ea68ddc48b8a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 480,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b01de9f-3303-4af5-b633-9c8519581a9b", "name": "Create Task Custom Field", "request": { "name": "Create Task Custom Field", "description": { "content": "Creates a custom field of the specified type and options to the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"field_type\": \"EMAIL\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "93d13283-06c1-4716-9d11-df87269623d9", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_field\": {\n \"id\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n },\n \"record_type\": {\n \"value\": \"\"\n },\n \"field_type\": {\n \"value\": \"\"\n },\n \"default_value\": {\n \"value\": \"\"\n },\n \"group_id\": {\n \"value\": \"\"\n },\n \"group_name\": {\n \"value\": \"\"\n },\n \"field_name\": {\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f526b9-926e-4cb0-8c1d-800144e3df97", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17bfa73a-3a83-4b36-b452-6eac8a2ce655", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e30e4d1-81ee-48bf-be1f-aaa5584c0434", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6d6c066-ac2f-4c84-9870-12a07af9b432", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f53d353-b7db-49d0-a9c9-28c88e4745d9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec1fba1-e420-440a-8692-22d6fb4f5e1f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a355e4-93d5-43b0-aa56-519e3829562d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f413e0e-b754-415e-9d27-49dad7f6f998", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"field_type\": \"YEAR\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89922723-e36d-4aae-bb4e-676907b3313e", "name": "List Task Custom Field Tabs", "request": { "name": "List Task Custom Field Tabs", "description": { "content": "Retrieves a list of custom field tabs for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a460d242-e80f-45ff-9dc7-1919da5383fd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tabs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39bbda3-ffb1-4bb6-b420-84aa19580ec8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15597a59-31f0-47c5-b444-41b97e4e6dcd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62af780f-a531-4ed7-8567-189785f450c1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e73d40a5-7f0b-4252-b4d4-918b49376cea", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c883b55c-7868-40a6-93e3-5b56de291be9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beac8bbe-9d52-48fa-9c4b-64fdf1ad09d8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f0b4ca-3363-47b3-9dc7-a1e27ebecd30", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113e3caa-331f-4422-b6d8-bc27c26efac6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3611c43-5f24-4fb2-a83b-3b2d34c0b004", "name": "Create a Task Custom Field Tab", "request": { "name": "Create a Task Custom Field Tab", "description": { "content": "Creates a new custom field tab for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c094e6d-8d89-4e5c-8659-41605a7aafef", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d20c0f20-e56d-4269-a330-61028db43e07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ac2f118-3edf-4005-b521-2ae517dd6d67", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad44bfb6-8864-437f-a762-1fad700d94ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a4f054e-4a68-414a-a63d-b96748f837eb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "337d0a62-09af-423d-80c5-5661ed5c5562", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ddd294-904e-4c82-a169-f6f8d80ee429", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5291bda9-9d2d-419c-99fc-0d8a1693250a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f2e0ce4-64a5-4ce8-ba8d-24555792cbca", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4083592-8392-41eb-ae7c-61542d6621ad", "name": "List Task Custom Field Groups", "request": { "name": "List Task Custom Field Groups", "description": { "content": "Retrieves a list of custom field groups for the Task record type. Optionally filter by tab_id to scope to a specific tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tab_id", "value": "string", "description": "Optional tab id to scope groups to a single tab" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9b000ed3-abee-4e35-8a02-5c2cbfc44fba", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20e1b057-716f-44d2-8008-109cdfecaea4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acb34534-b661-486a-b966-1ad749cddeab", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2c30390-be72-4455-8b80-08703e3dbcf5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6deef43c-3eda-4b51-9b43-f1bcce308636", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396d2cbc-c345-473c-8113-ee1a174cb820", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5834d662-02fd-4838-aa35-d9ec6fe7bab6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c791ce7b-1fb0-46b5-accc-4fd6c64b5619", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0285b1-f9e4-4c3a-8bee-0f63e91824e9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tab_id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a4f2a18e-08a4-44f9-adac-3f2e761d9330", "name": "Create a Task Custom Field Group", "request": { "name": "Create a Task Custom Field Group", "description": { "content": "Creates a new custom field group for the Task record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "34468ca1-25e7-4531-8449-f99d9635348f", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bb22b1a-4d16-4317-8300-9f1d775b12a8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618a5c64-5212-4566-a58d-17f1e8eb9b56", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7ff895-16fc-4135-a31e-dd6af61be225", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9493f3d-fc22-4c05-9937-e43094479ab1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b9ba53-75d2-4e03-8088-64d7ba9ed190", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dbd3f8c-9af6-4cdc-911d-12b30c0a435c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed0ed74d-f7f3-4abb-a67c-887fe4dd4de1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04d83721-1419-4cd8-bd88-cdc4de91b806", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30253486-d822-49ff-8351-6f85e29d2f1b", "name": "Retrieve a Task", "request": { "name": "Retrieve a Task", "description": { "content": "Retrieves a single task", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d7f394ba-090c-41ea-b01d-7d907d2b80bc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review and respond to client feedback.\",\n \"type\": \"CALL\",\n \"priority\": \"CRITICAL\",\n \"completed\": false,\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"modification_time\": \"2024-03-15T10:30:00Z\",\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"last_updated_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c777b3a-5872-4ce6-a01b-c58114336454", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5212fe-aa74-4eae-b9cf-ebaea2e28f54", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9b5540-d643-4c44-8266-c23a21f4daa9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c78486aa-42cd-4b2d-821d-caffa6615ba3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dd77cf9-3eb7-4738-8c64-57a345d38bc4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c77a370-0149-4c2a-82dc-b189e7a4707c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959e4efd-42b8-4365-a9a3-fc89ca2f2fa8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "136204bd-11b4-4ea6-a224-71fa01838d27", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63c1969b-942c-498f-9cc7-226676b914c1", "name": "Delete a Task", "request": { "name": "Delete a Task", "description": { "content": "Deletes a single task", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "30894063-b7c0-42f2-b7dc-9e17f28f5898", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ffab0b3-d855-4992-b685-3210c2cd007f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3efc3d18-a9e2-41fd-8009-2146c6fe42e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46eee967-b520-4d24-aaef-987eb21e7a35", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3c09c6-347c-4f1e-8959-33f9211a3daa", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd8c9ae9-a632-4501-bb0c-de690b62dcfd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c564fad9-c265-4da2-b526-33836d7d287a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d059051-18e3-4862-bd40-01c892806d5c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6af099f-805c-4c19-ad4a-af29bedd5308", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e1f9123-87c8-4d97-bfad-7cae494a4472", "name": "Update a Task", "request": { "name": "Update a Task", "description": { "content": "Updates a task with only the values provided in the request.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "last_updated_by_user_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23ea0452-cfa2-4859-a357-73a3bf9ed768", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review and respond to client feedback.\",\n \"type\": \"CALL\",\n \"priority\": \"CRITICAL\",\n \"completed\": false,\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"modification_time\": \"2024-03-15T10:30:00Z\",\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"assigned_to_user_id\": \"string\",\n \"created_by_user_id\": \"string\",\n \"last_updated_by_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ebae3f1-1984-4778-9d83-fff991bb98fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cea774-4b7d-44aa-bb95-75c9696c3f7b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a51db73-b3f9-43fb-9a3e-c75fc3e1ac43", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cda5a6d-4ea2-495d-8a6a-f95c86147ff0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac870e03-64c7-48a4-a610-bcfa9d925a53", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3dbf8d-6cb5-4ce1-86fe-a120e3a10590", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a2ae198-f7d4-482f-92bb-0199071dffaa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bad8a40-21db-4b15-808d-4bb7b9526a61", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "due_time" }, { "key": "update_mask", "value": "description" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 60,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b676dec-2a45-4fc4-8d54-ad5294405cbd", "name": "Delete Task Custom Field", "request": { "name": "Delete Task Custom Field", "description": { "content": "Deletes a Custom Field from the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "37a01e76-be4e-4191-a083-5be99deb963d", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "749c0874-71c6-4ff1-b6ee-d707401628c3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac3b5ce9-0171-4d21-abaa-9661720a602b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c580e2a4-c741-4a77-9cff-444be6d6e9ce", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d67bcda6-d886-4d0b-8042-227107e2b0df", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a268a8-e972-4074-b38f-51ce772deccf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c56aaa-1d49-4836-a404-82c5f2862c6d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc9d711d-4b77-4927-b4e2-f856c96032ad", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1927f3-3fea-497c-bd27-edba59fd18c0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66cbf21c-0e47-4896-aca8-8ec29df09d20", "name": "Update a Task's Custom Field", "request": { "name": "Update a Task's Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Task object.
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "options", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d90d648-1b04-46fa-8e83-701d8dda86d0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"label\": \"Favorite Color\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"record_type\": \"TASK_NOTE_APPOINTMENT\",\n \"field_type\": \"CURRENCY\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bce91b60-55f2-4a0d-8fc9-84b4701cffc1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ad24cb-87d3-495f-823a-1f7cdd9f04d8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392f6347-dce2-4f4d-836d-2a890f3ce098", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b9a6310-372f-4514-ac4b-27a780fa28ac", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031f9859-503e-4320-8ed8-30a2a6ce337d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05504e4-b4a9-4f13-8ddc-4f51cc9d9971", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dc09917-4c1c-4e94-87bf-19829e311404", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "621256f7-d903-4751-b97a-1251d53142d4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "options" }, { "key": "update_mask", "value": "label" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "387aca3d-71ea-4f61-b20b-2eac8760c937", "name": "Retrieve a Task Custom Field Tab", "request": { "name": "Retrieve a Task Custom Field Tab", "description": { "content": "Retrieves a single custom field tab by id for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d6ab7df4-96de-4c71-82eb-f04be9682ca0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed9c92ef-0734-442f-9690-b916d5550fd0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f563ee40-b2c6-4485-8965-8e0db9a62706", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a77519-c683-4b58-95da-7e2820c6f979", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd768215-6bf3-47bd-8e65-25319e3ef487", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d244989-2619-45c3-b000-fb8ea35241cc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f204e6ac-1e79-4925-8f75-5ba8e0436f3f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a92b5fc-07a0-4d13-bd8c-570b6f23d288", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767e2714-c686-4079-9a81-5953a0aa71e8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46b76f98-dce9-46b8-9726-4a74e9ff2af2", "name": "Delete a Task Custom Field Tab", "request": { "name": "Delete a Task Custom Field Tab", "description": { "content": "Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "16da2524-41e4-499d-b776-9ba4e1e5b3ae", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "127c6ce1-ccab-4851-bd54-fc6e28ce6824", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30daa676-58c6-4095-8559-80d8b3f04d1c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7ade61-a5a5-4b7b-99db-2e11684c15ab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fca6b9bc-cf95-4d04-aa1c-fd5513e15354", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b32b5b-99ba-4d24-a514-db0efc361d0d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e772d57c-ec6f-4292-be86-b7542cb2682e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "423425bf-95a9-4d5d-804e-d58e8ce2560b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fabb343-0c81-4a10-aa24-4522b2c8ba28", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29ab7f34-31bf-45e1-b4bc-2b0a34f72ab7", "name": "Update a Task Custom Field Tab", "request": { "name": "Update a Task Custom Field Tab", "description": { "content": "Updates an existing custom field tab. Only fields listed in `update_mask` are applied.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "593adc23-7392-48a9-a880-86e15e84b25c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Personal Info\",\n \"order\": 1,\n \"record_type\": \"CONTACT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4785bfb-612e-42c6-81bb-e282e22c8476", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a47515-51b5-4ab5-abc0-06f7240ea2c1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec2810c3-2679-42f5-a2ee-898b394ed5ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5f52ba-aa02-4279-bd82-52f9c28792c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d6cd0c7-f209-46da-b4ab-25176a6aecc8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f4abe4e-a1d5-48ee-9ec7-c55d02d159ec", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd0dcf82-90f4-492c-bcad-0f0afaecd8a1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33e180f2-2f56-42c6-93f3-3f6c7fc1e28a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "order" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tab_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 8273\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "725c2ff4-0377-4226-bce0-98e9db2d8e55", "name": "Retrieve a Task Custom Field Group", "request": { "name": "Retrieve a Task Custom Field Group", "description": { "content": "Retrieves a single custom field group by id for the Task record type.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c58a099d-8728-4040-b64f-9eb9c0f8d4e5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c87093b-1e02-43c3-b501-5b4acb3d1654", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0497f3b-9446-4f69-9568-13f383e44a2f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1063841d-b910-4b23-9877-c0a46f074ae5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70718e22-75e4-4bb8-87ba-2302983a72fc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f9d86d9-8d84-4fbc-a330-60c3a54a1e4e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d53a4bb-0e98-4bc9-b758-c4a0e327aa6c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bbee5f8-beb5-401a-937a-2c6d69104ab4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdc3532a-bc58-4655-b1ab-94280b642913", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d09524f1-c9f3-4716-919b-d95a70a29ee1", "name": "Delete a Task Custom Field Group", "request": { "name": "Delete a Task Custom Field Group", "description": { "content": "Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ae222914-2ae3-488b-baf7-9fef612cde42", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdc9ddd8-1095-47ff-9efa-d698cd0e1d13", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86ba917-8dd9-4859-b7b5-192ae1f17f85", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbbe3a41-69d4-4687-9a16-bda84ea4ed56", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7f4172-fdb6-4edf-a0e9-8e988e50562b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077cb35d-bdf2-4bf5-b51f-195f4a1b5ea2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ce0708-042d-4be9-ba4f-68b1da39fe4d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "154529c6-93c3-4ce4-84ba-48d4fd1525fb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "029ba6b0-fd7c-4516-9ffb-0f56e305e45f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "952b6e80-1702-4a36-a442-c7de276552a6", "name": "Update a Task Custom Field Group", "request": { "name": "Update a Task Custom Field Group", "description": { "content": "Updates an existing custom field group. Only fields listed in `update_mask` are applied.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "tab_id", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0f7a4ec8-f7ee-4bf6-bed5-2eaea2b88eb4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"order\": 449,\n \"tab_id\": \"string\",\n \"record_type\": \"TASK_NOTE_APPOINTMENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9c2c6c-1c49-48f8-8727-f3f7f40b6685", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d030b3a-f38b-4594-a61a-7474b7bda711", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6fe72f-4c24-4b3a-843e-077214941113", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af69d3b7-84a4-4b4b-8bd6-65fed018086f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96d603c-118e-439a-8f90-974408893001", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a863fca-5359-458c-a98d-f02da5adda00", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f27e236-604d-4dd4-b201-53dad3e52ae4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6adef41c-6eb8-424c-ae7c-d28fcc6885a0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7776,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccfafb78-c55d-470c-9903-f803bba7b597", "name": "Retrieve Task Model", "request": { "name": "Retrieve Task Model", "description": { "content": "Get the custom fields for the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6632bbdc-03f6-4a9b-a62d-fa16e7a91e0d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"optional_properties\": [\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "103e30c3-8e1b-4dec-a309-0bc6a08542e7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd0a9bc-39e8-45ff-a2a5-fd3041cbe0c7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7720ea17-3a24-4a68-ad50-6e127a7466c4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a648a228-f793-4b9d-8430-2ed890497611", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0b90832-79d3-4237-9614-2a3e66a82a94", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "029400e9-de6c-41c0-8d5e-a940e51996b7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4b7dba-4de3-4aa0-9549-8032bcd0622a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "869ad9b9-3b5a-4685-8c9a-d98464d09c82", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "934df2ce-eddf-4931-9129-9ff2eebb665a", "name": "User Groups", "description": { "content": "User Groups endpoints.", "type": "text/plain" }, "item": [ { "id": "73fdea60-655c-415f-a556-9b0c1145c144", "name": "List User Groups", "request": { "name": "List User Groups", "description": { "content": "Retrieves a list of all user groups in the application.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ab0ea0d8-2114-473e-9fbd-77e1b3257e54", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user_groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5920c00c-7a9e-47c6-b8b6-97a7c69d69f5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9076aa4-228e-419b-ab9b-51f6450fd364", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa6a046a-24c1-4908-8291-44a1b65e9db1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d11863e-3f55-4262-84ea-2a34fe42abbe", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964a1cee-5021-411d-aaf5-05a8ccb45762", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581f88c3-ba29-4c7c-912e-394eca336f93", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e325cf8b-7cb4-422b-a18f-b229268aa392", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48e0b767-789d-4ab9-88c8-ac0eb1048ffe", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dffbe8e9-361a-4ce6-903e-0ea034abe63b", "name": "Retrieve a User Group", "request": { "name": "Retrieve a User Group", "description": { "content": "Retrieves a single user group by its ID.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d75c5a13-06e2-47ec-bee8-75b7a1b3186a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Accounting\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18100f73-73f7-4b12-9080-d474fd85dbd9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea8192c-2dc7-4343-8b0e-7637441a9ba0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "410d549d-77ad-4b72-a9a6-7956c1429212", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c5c981-2f64-4640-b679-976b8969551b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd2c0952-d6ce-41d7-9407-3794b6f77e1c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af14a301-0df8-4003-936f-21940be52e87", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf493eb-09f2-4e97-94a4-f958c8d336c3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c43c375-a9f6-46a4-a081-2db3853684f6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "userGroups", ":user_group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "154263a9-64ad-41b2-b4ac-8b0159d59125", "name": "Users", "description": { "content": "Users endpoints.", "type": "text/plain" }, "item": [ { "id": "a531310d-2d66-40c1-976a-be43deda364f", "name": "Get User", "request": { "name": "Get User", "description": { "content": "Retrieves a specific User", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "332e7771-3ce3-4163-9a3d-ab4107601738", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"partner\": false,\n \"admin\": true,\n \"status\": \"ACTIVE\",\n \"id\": \"string\",\n \"global_user_id\": \"usr_abc123\",\n \"keap_id\": \"string\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"middle_name\": \"Edward\",\n \"nickname\": \"Tony\",\n \"spouse_name\": \"Mia\",\n \"suffix\": \"Jr.\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company_name\": \"Acme Corp\",\n \"created_by\": 1,\n \"create_time\": \"2024-05-21T14:30:00Z\",\n \"updated_by\": 1,\n \"update_time\": \"2024-05-21T15:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4b3a73-29bd-4588-a036-90ab361074de", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc74f42b-ece0-4e9b-beb7-ab9e035074f8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f8acf21-4eaf-4be0-8711-d69419a5a83a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ac35554-4592-4db6-99d4-9627a026d35d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c73c7f03-dbef-414d-804f-418d1c693493", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d6b173-5f18-4c9c-912c-67cdf83530cf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f6288b1-8995-4db7-a834-01406b9b0dd5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef664b52-6f92-4697-843c-144d127bd46e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f32c07f1-7445-4840-ba27-c5ec7db1f100", "name": "Update User", "request": { "name": "Update User", "description": { "content": "Updates information on a specific User", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "given_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "company_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f89f76ca-0eae-4d1c-a3bb-da2814768448", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"partner\": false,\n \"admin\": true,\n \"status\": \"ACTIVE\",\n \"id\": \"string\",\n \"global_user_id\": \"usr_abc123\",\n \"keap_id\": \"string\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"middle_name\": \"Edward\",\n \"nickname\": \"Tony\",\n \"spouse_name\": \"Mia\",\n \"suffix\": \"Jr.\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company_name\": \"Acme Corp\",\n \"created_by\": 1,\n \"create_time\": \"2024-05-21T14:30:00Z\",\n \"updated_by\": 1,\n \"update_time\": \"2024-05-21T15:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8028617e-5fad-416b-9b49-6140fef7e523", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72490358-76c5-4c4e-aa1e-6baf9a3cacce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aef1e7b-cf85-406b-aa37-2f8e795a9a7d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9560d93-bb23-481b-a813-77020f3ef0d7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7fdf7ca-a79f-4545-9dcd-b6e00a05f16c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec7d401-4a6a-4c37-bb27-3134cdc6525c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fae538f-b378-4f67-9710-3088c269350b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e5defdc-3128-47ca-957e-7139181b15a3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "family_name" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "608308db-f07f-42c2-9d1b-109c8959ad29", "name": "List Users", "request": { "name": "List Users", "description": { "content": "Retrieves a list of users", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `email`\n- (String) `given_name`\n- (Boolean) `include_inactive`\n- (Boolean) `include_partners`\n- (Set[String]) `user_ids`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`.\nFor the filters listed above, here are some examples:\n- `filter=given_name%3D%3DMary`\n- `filter=user_ids%3D%3D123%3Bgiven_name%3D%3DSmith`\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `create_time`\n- `email`\n- `name` (sorts by family name / last name; uses User ID as tiebreaker for stable pagination)\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "10", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a3733357-f15f-4a16-80b3-036e1b5740e1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63bc9955-be8e-4c22-9662-40b9da9d60f5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1638e5-71c9-4792-b2b6-0b0fc3dc4df0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155cae8a-cdfa-4b43-acd2-9d0537ee501a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5573f35-d77c-4109-906d-f42f594b25be", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d29678f-3f12-487e-b780-fe92daa37df2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ffa351-1be7-4fe5-938a-3d45f4c7b22f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e89ac272-4488-4624-b96c-71da7ca951dc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed64881a-4642-444e-89a4-1a2cea9b2299", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "10" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52691ccd-7297-4cc1-b8c6-bb4a2a639e37", "name": "Get User email signature", "request": { "name": "Get User email signature", "description": { "content": "Retrieves a HTML snippet that contains the user's email signature.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "211b46e9-4355-45ee-aa7c-a303ef04b9e4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e640bc4e-5f3a-43f9-85e3-d194e3712084", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28140ad2-695b-4316-938b-d79e39705d06", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b66a6d92-161b-4d0b-9fdf-421eb272bb65", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae8ff778-b8fd-4891-9b8c-ddb342cca6d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e41a6753-88e6-4cee-bcae-eae818f19e89", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07a26245-3d77-4624-ba12-fb4fb9e10b95", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94d5f128-f714-49f5-a2ee-d03be807aa6b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c89ad721-c7bb-4144-a24d-0529176d1e4e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c664fc22-a720-41db-b373-2aad436f3161", "name": "Retrieve User Info", "request": { "name": "Retrieve User Info", "description": { "content": "Retrieves information for the current authenticated end-user, as outlined by the [OpenID Connect specification](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo).", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0ef87b95-ebb7-4f19-bf65-2e4cc7132e0e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"john.smith@example.com\",\n \"sub\": \"string\",\n \"id\": \"string\",\n \"keap_id\": \"john.smith@example.com\",\n \"family_name\": \"Smith\",\n \"given_name\": \"John\",\n \"middle_name\": \"Robert\",\n \"preferred_name\": \"Johnny\",\n \"is_admin\": true,\n \"tenant_id\": \"xyz789\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f4fc44-a19f-47f6-92f8-e120f9fb7e3e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be8179cc-e508-48e2-91ff-8c4c532a52ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074d5a22-7d26-4207-a9f7-bad723a9fd62", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b34d5d88-3141-4640-bd3b-5f2c4b8ae9a1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed1f8cba-9cf2-4aa6-b2ef-7af11320b57f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95b543c-3716-4bd4-8e17-28ba13bd9f28", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b159afe8-6eb9-4377-9528-65a35bdf26f4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "969ad1da-be07-4f7f-88ef-fdd231e37a06", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "oauth", "connect", "userinfo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "139e5ddf-29c2-40c4-936a-d26a52534c0b", "name": "Webforms", "description": { "content": "Webforms endpoints.", "type": "text/plain" }, "item": [ { "id": "68e80e74-679e-4e72-b8d7-130c2e9270f8", "name": "List Webforms with filter", "request": { "name": "List Webforms with filter", "description": { "content": "Retrieves a list of webforms", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `name`\n- (String) `webform_type`\n- (String) `since_create_time`\n- (String) `until_create_time`\n- (String) `since_update_time`\n- (String) `until_update_time`\n\nYou will need to apply the `==` operator to check the equality of one of the filters with your searched\nword, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:\n- `filter=name%3D%3DContact Us`\n- `filter=webform_type%3D%3Dlegacy`" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to order items.\nOne of the following fields:\n- `name`\n- `webform_type`\n- `create_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0aeca4e4-4428-4db9-8af4-4fc6a010c796", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"webforms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aca1744-4b6c-4fcf-881a-fbb9994c757e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1539591-3717-4c91-bfda-611a3415ddec", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca3d0841-6fdc-421e-b41f-79938e270231", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ded892-8221-4664-b504-e1d6a70c3be5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "616ee4fc-097b-4ed1-bb30-286bd990fe66", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68bc7515-8445-4168-b057-abe5a658ce22", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7978b226-7b43-4b7f-8bab-780a4327cd39", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8149db92-836b-41f6-a765-0f4479ae2171", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe6af1eb-b7b3-4590-9df3-0678233f5f6e", "name": "Get Webform HTML", "request": { "name": "Get Webform HTML", "description": { "content": "Returns the HTML", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "auth": null }, "response": [ { "id": "fb2dce6c-f1ed-44d0-98a1-979de914ced8", "name": "HTML content of the webform", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "text/html" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/html" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e64f0d3-7887-4f31-b1b9-28b5f3586429", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edefe822-97d9-4f9a-a5ae-8619f7efd9be", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a963756-9b7c-4248-9640-1d34cd9bf2bb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42fe30e3-d04a-4e9a-baf0-6430f6be2332", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca3f43ef-38f9-4b60-a5ea-4fce92fc6305", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33e77ed4-ba77-4516-b5ce-3b69a8930558", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c1398bb-6f5a-4d5f-9904-0f2f2d0e361c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25acdc0c-51d4-4ea7-9ae0-4dfbc5273193", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "webforms", "{{webform_id}}:data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 2726,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-stge.infusiontest.com/crm", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "webform_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "subscription_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the report (Saved Search) to execute", "type": "text/plain" }, "type": "any", "value": "string", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) product_id", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "category_id" }, { "disabled": false, "description": { "content": "(Required) ID of the payment method to be deactivated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "payment_method_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_item_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "option_key" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "file_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "sequence_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "commission_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "affiliate_id" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "https://api-stge.infusiontest.com/token" }, { "key": "authUrl", "value": "https://accounts-stge.infusiontest.com/app/oauth/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "3200f6a8-b5ba-4792-96d0-e3f9733f67e5", "name": "API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Keap Public API Documentation\n\nContact Support:\n Name: Keap\n Email: api.keap@thryv.com", "type": "text/plain" } } }