{ "item": [ { "id": "72dbc70e-a04e-4b2f-b84e-d4a6e9eaf6a1", "name": "Affiliate", "description": { "content": "Affiliate endpoints.", "type": "text/plain" }, "item": [ { "id": "05ddf3f2-d187-4856-a64a-44491a1d3f62", "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` - Wildcard matching allowed\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. Any other characters in the value,\nincluding `%`, `_`, and `\\`, are matched literally and are not treated as wildcards.\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": "9ec491d9-fda7-476c-ba28-f7d2889ca0fc", "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": "52ee404b-3960-4f1e-9586-7e383853f041", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba15bf5f-a7c8-4556-868d-0c802d3b0cf3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a708a23-3d98-444d-b1b4-2b987fee144f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "798c2c91-54c3-40e4-b005-08309dafe2c6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8401ac1e-037f-4201-a0ae-05e68778ce77", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b7b7d1-ca73-4d33-bb01-e01cd0a4b87e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acc004ca-879f-4169-8242-6e44c767f524", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a38afd01-92ae-4c98-9630-2200579cc9ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "412e43b3-c450-4305-8abd-3f7a72811fb3", "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": "26610621-5b2f-4a7b-8e71-410f6892266f", "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": "89e0cccc-e1b5-4389-9bcc-76ef86f4d568", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc517c41-b1fa-4e94-af7f-7b88448f8ecb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c47720e7-5c9a-4440-81db-40ec3bc34cb2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3d78e40-4226-4199-b795-41d79dc94bdf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b72c17d-4d64-439a-ad2a-03fc2b453c07", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f3adac4-8b6c-4328-9103-ca74dec99762", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ba86b9f-d67d-4e65-b94b-307199f27a02", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "812c91ee-3976-4cab-ac60-ba87962cde00", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b1c0dd6-6d4b-42c1-b15a-bacfec1e3328", "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": "62b2c1c4-1af6-4c77-88e6-ec873d36c600", "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": "8cc578ae-a86c-4c17-8fb7-f7f4c6967f37", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19011195-e288-4f23-ad9d-6b2587b91f2b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd1202e-8e9a-43b1-8cd2-c09edd571f8b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073ffe79-1b3a-49ce-9d62-2ad02253f1b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bfa31db-e8b5-40bf-95f6-c93b5d648c6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93be0983-f56d-425d-8023-13c08eeba084", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36035ec2-2380-49a2-94a8-b7327051e411", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3328392-70b7-46dc-9799-924a9b65983b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "099350a9-dfc6-4551-8283-8ba09df88764", "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": "b6de0db3-ed32-489b-90f9-775a8bf64b37", "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": "37d0c4cf-c269-49cb-a993-650937362990", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4036bd-2f9e-4675-a956-08dadc189d67", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bcba598-4f0e-4bf2-8cc0-1fa564ac2cff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89989393-eeff-48e3-bba5-bd6eb80ebc72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de7001d3-a40d-4c96-ab0f-e082a64bf743", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c73e31-8bd4-42e5-9e05-e12e471cff04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79100cd0-7d47-48ec-a123-d9379ba9cabd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ba81fb3-e8b0-4d87-8902-c4715d53b01f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d5c565c-95cb-494a-bebb-fbc04dea907b", "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": "ce40f17b-0c17-4f1a-b0c5-f746f9ebfde1", "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": "2be1faad-ead7-4816-8f28-16914a00c083", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "957f1ca6-8216-4a5c-abd0-7b0954116057", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "829eb152-82b7-4692-a7ff-24fd5cbbd665", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6395f08c-794c-44df-88d3-b3be814d55c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f945d7-f848-416a-9f2d-c8889a8cd54d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b549f0f-6bbe-40c7-808b-7ef9a69aae9e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27cf6fe6-bdca-4f1f-a663-35b6f07dc7a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d6788e-8a65-498f-9fac-49be554a2e24", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bbe4061-d446-4bbb-89d0-a592e1920bed", "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": "d59f959e-9932-4c3e-bb1d-ee644fc50bcb", "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": "adf66c39-c84c-4128-b4a7-914c8b2d0ed7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "464c7bd6-7edd-46dc-9e94-c2ddcc1d2783", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "665be4f0-0daf-4a03-8387-55568048de01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d9d93d0-56c5-4ff4-9c0b-d9e88f48b960", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47dd6528-2cc1-48de-9352-484bc4d51492", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfba7ec9-5e6d-4056-943d-2e15d8f216c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "989e8d0d-68a1-4667-9bfa-676b3f935786", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18196cf3-902d-4b7f-8a1d-3c088c83f486", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74d35fcc-11c8-4b96-be66-62cebad50c64", "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\": \"WHOLE_NUMBER\",\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": "2e93c8c7-0755-44f8-a11b-e77c660f992b", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "bb13c11a-d964-42c5-a5f1-8032de4425a0", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7f4c97-bdb7-4ea9-9530-75a881bf2203", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a19346eb-e730-4ee3-a27d-226c5700f287", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd7c98b-02f2-4b37-8965-0689ec43ea43", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d6f1d1-e901-4c14-9756-441029eebe75", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c846979-7f9e-4f5d-a5ee-08455b31d64f", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ae2ec35-9020-46d8-8377-f4cc9a7a7750", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6048a1a-0817-48db-819c-680bd8307ffb", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd7df21c-224d-4811-99fb-7f1b602b5e7e", "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": "6ad82e5d-9153-42b8-8d3a-a8397ea8726f", "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": "fc21bcf4-4261-4d60-98d8-c79cbc1eb537", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a70dcded-f15d-4d06-a36a-6280a0940a70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c4aad7-a3e9-4f4a-89f8-15b23c036b49", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7de8995-04f4-4d74-a66c-7666c36b33fe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce72a89-4579-4717-80cc-5564569643ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c9a2564-1b3f-4a18-844d-57fd613d5bb2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c63533-a15e-4f47-a204-89d3e45e0a0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8361127d-9463-46eb-bfb5-7cc7acd9a23c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42080b1a-a2aa-4bf3-aebc-8014668264e6", "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": "5b4ab094-ddf9-4c2c-9639-8cdd038d4d51", "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": "a01d668e-66e7-4126-87e4-e955ea410737", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3142726e-840c-40e5-afad-ccdcb627a5cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b33cc92-22eb-4c4b-8aba-12fca947e064", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9db20b75-4b7c-48bb-bfca-0c8fa9012ed7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f95858-445d-4fd7-b732-a27e45af66e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccc3ee8e-c389-43b8-909e-72a59da0d173", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f9e264-ee1d-497a-b6a4-ab6a1a50f4dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b84d665a-62f4-465f-82dd-573e4854b537", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0417352f-c406-4239-8dd4-83075009b09f", "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": "d1df8386-397f-434c-b2fe-5f2241428e4e", "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": "b7f84349-bc57-490d-8bd9-7e69595b34cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ade287ce-0486-43c5-8e87-4abc2404e0dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b676f95-57b4-45b5-8014-7a50237c2d43", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f58b2c22-1c76-4019-b94b-d26dbbd3e76d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34b6c26b-e606-48e9-829e-30616565f398", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ea28886-5d49-4f92-a606-ab157bd115ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19c8537e-d198-48d9-b2cd-434525f01e78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24ca97b-9e47-474d-bd14-9ebadea3d204", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41916f23-d30f-47cd-a225-1448daffa7a3", "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": "f0a5f6aa-e167-4107-93dc-10713ca2e51b", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f4b0b6b-07fa-4269-97c1-74835cd8b77a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0089937d-50ba-4d6b-9504-a2686d06357b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be00225-268c-4c83-b988-7138ab04684b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28363432-10fc-4bd9-ba56-8b9f63ac5e8b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22d22538-c772-41f5-8142-ba3c2a30a291", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74227047-d8f2-487a-a20e-b2e49076edf5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a8656eb-47d6-4b19-90ba-bf8e96d67a7d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d35d77-e3f3-4a76-974a-1a0aa327b91b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "522c0e1a-84c8-47b7-8666-cff20dbedc80", "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": "ee34f1f5-285c-4414-81b1-950ff6be5ed0", "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": "7be882fb-f647-4887-b1aa-8d431be4db63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3ed47c-8048-477b-b512-6a88d9f7b1ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5cd42d6-5b19-4685-b2ec-d4b2d3af9331", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66f9ee22-d5e5-48ef-9ed2-fa50190b166f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814771ab-1b0a-414e-810c-77fb5310433f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c4f5fb-f4d8-42d9-a9d6-4c6c597ae5be", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc82353-ebaf-4663-a3be-685915faea4b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "060d5486-ad32-479e-9cf3-4942ba7e3618", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68dacabf-1b09-49c8-b1eb-f085c461a8c6", "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": "d8e0500a-8fc1-492e-a034-d1338800f8d7", "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": "3a9f19d9-cfd1-4e7e-b2e5-bd87cc11810a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa4a36fb-bde1-421c-b1b2-340e2a125c87", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b738a37-90a5-4127-8525-247eccbe1e34", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610b6419-61de-4594-9bb8-4579408a9290", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e29e2f8-eabc-4380-bd86-c152dc6be7d9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f30530-44cb-4499-973e-e7fbe154e761", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fa33d99-d3e5-4e74-9af1-535e72e7ca70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d0813ed-692f-436d-a60f-b2afb30d1c83", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "333ec1c7-fe94-4ae9-854b-e9bf1cbb9a10", "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": "206b53be-21aa-4110-ba17-5d8df6d65d20", "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": "8eb31b47-8a1f-4021-92dd-0337b721b4e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7229a112-e919-4fbf-baf5-f9cfb09c9535", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffccfc7d-4963-4251-ba0d-5d9ab5f51802", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61017362-212d-44c3-9a39-ef8bbf6cc466", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7934141-8e7f-4f1c-ba19-bba5405d36cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65068871-c8d9-4a02-b91c-d140bb72993f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f184810e-e3d6-4de1-a556-dc13c0b0278b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96ace4f-b8ba-4ca7-b8b6-f08210a656d9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "467f3511-3380-4d24-9cca-287ae2c08449", "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": "1ab3d4ab-465e-4db1-9885-3403ce41542a", "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": "a9c8920c-7b66-4da6-aa79-9e01596ebb60", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a566ed80-29c9-4db1-a4b4-4842599459d2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1616c800-223d-43d5-8dc8-752d31c5ebb8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee8b6d0-577d-4582-864f-9e4e23531e02", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23130793-0421-4829-a406-632888bad8a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d047e5d4-2071-4fc5-8005-57eeaf6558b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa992e5-85dc-49ad-b904-2996255cf35a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3aa1b85-9d34-47e3-b25c-55bbef83197a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21b6d3ba-7ad2-4ab6-912d-03248ad7f3ad", "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": "43f06209-fc98-408b-92da-07526442ce5c", "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": "b597fffe-3c5b-47de-a200-16d7bd96af54", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e1ba1ec-668c-444a-95af-34c0641e9d16", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c9d9b1-11a9-4414-ac78-267f2c964375", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392be1d5-3bcf-42b1-b73a-2a89097ebe0e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0f7692c-390b-4877-a1dd-fa44932b4396", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fc36466-e400-473a-ba19-660d14ee0185", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7569896-5676-40a9-9dc1-688a847272a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7223e2ae-ff35-404a-a7a5-f09d116919e6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "785f13e6-6142-4f37-9bb3-5f5b790202aa", "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": "payout_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": "unused", "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": "3eef51e7-1c93-44d3-8693-2c912aff040b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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": "45683c9b-2866-47fc-b974-3f1627ce67f2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c8877f9-e825-420f-9291-b5fc8a957d57", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "969519e8-6ccf-4341-8ea3-6e78e9a541b7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "075cd429-4536-453e-b470-821f95c6654c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "327cb103-7eba-41da-bee2-75d897cc8ad3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1a5c402-7d10-402d-9dbf-25ac8b21a61f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d51458eb-ed18-41a0-a542-d3b219c030a8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a40be19-85a7-4b5a-b537-533fbcbf60ab", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "899cb72d-54ff-4eb4-851e-dfc83f68f890", "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": "ed489941-6408-49fa-b39f-96d5a55b9087", "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": "50930edf-a9ee-4f6c-876a-37565a10b670", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4e09cbe-4c8f-445d-9498-641721e4a194", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78e3290d-3401-46a0-ace2-d64c00bfc1ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b80aef-63ce-4efc-b8c5-73396cbbccce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e068447c-02b3-4775-b4fc-9b22507a009a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c3b8bd-ab69-46fa-b581-042ff338cceb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f3fc206-7914-4c51-a659-2f77bf48a3d9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6f8eeb-f7c8-4033-b302-572e0deaba31", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45a7b6d5-f239-46de-9a2e-d1f237c4ba75", "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": "19f59480-1bc7-4c44-8305-f6a30443ca52", "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": "4524484d-ab4e-4d59-98d4-9f7d035f15fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9c03b9-8870-4b22-8527-b26a2213dbbc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "783594c1-23e6-4117-bfc6-e00aa35f3fcb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893604a6-7f3e-4ed1-958f-e62f20097b37", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1330a9b-dd7f-4353-b49c-03d8a42d0fdf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ce6f523-0059-492e-bbf2-8b4d5ef8fa38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08133742-b367-4acc-8864-07fa95aac661", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3921ac5c-f617-4fc8-bfe5-ce84be1be184", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ec4009e-11c7-454c-a368-4b2df1bb043c", "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": "payout_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": "unused", "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": "e25d3e66-57bc-47b2-922d-1a938eb5913b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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": "ccad46c4-0220-4d67-b1c7-5965980f3629", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976f250e-d362-4959-87ee-8475156dd4be", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43f6f2e6-d54a-48e8-a0b2-4e12af453a54", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c112255-476c-47b0-b7be-aaae645a0415", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c98031-4512-4f54-b4cd-a76523953c0d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25d47a0c-2faa-4e01-bf3d-707bcda604b8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55669d7b-6fc2-4fbb-9ee7-ed05817ff01b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed1c89f-401c-4f01-a240-57909cdbb59d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "469303ea-4b30-4d46-8c6b-f56b55bd547e", "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": "b53e99d5-64b2-4488-b133-9fea4c7c9bc3", "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": "5105d15b-ecd0-4e27-b9c0-7a0c2e43f5c9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed44360-f1ed-4634-92e4-ff07508e8c95", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbfc6d29-083c-401d-b92c-df4c3faff394", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fba09d8-96e0-44e1-a725-1892fc792d60", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11edb7a1-dcde-4f96-9c3b-1cd2b8011b73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f984cc99-59f2-4705-a043-1d832af2d99b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0231c61d-9c3b-4e99-8e37-6c18957cf714", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0e3f888-d669-46ae-b45f-8511c4500e39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4313b3ab-1523-4b2e-bc77-5bff2b61c15d", "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": "payout_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": "unused", "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": "14b27980-f9d5-4c0a-9131-ef976c980e4e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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": "4a10b295-b469-4c98-b84a-377a8e94c996", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2b3dbe-90c6-4410-be86-c9631340bd88", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4e4f63-bf96-4119-b101-4ae463df113b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ef0169-bb80-4ece-95e1-80b555fb4644", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "139278c2-fe2f-4d21-8786-2e649466ad72", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba9f42d5-2f41-4d5d-9a29-0ac6c4966b38", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ff05fa-fefe-4e65-8089-4f3280ec2b49", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95cc3e8a-0744-4e66-8fb9-0a5dfe83f8a1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "dollar_amount" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7dc2bbf-c61b-4677-9451-071f74c99bdf", "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": "9e783ae3-18db-4cdd-8e5c-e083ee29cb72", "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": "2f648e1f-d761-45ec-a831-6b8aa57571d2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "930fe3fd-a031-44c4-b90d-306408036b4b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d24f1e15-53a4-4abf-a45c-a4cdef379029", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a3d2fdb-1cc3-4c7c-91df-976425a8a2dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ade032-69a9-4c09-94ad-cc02b3c4ea2a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e748969b-a9f3-43be-9908-7422610596da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "483e6f0d-bfcb-40f3-95ad-f658f0de07e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255f7263-ae19-4042-a960-92d8d961cea5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67c844eb-abf4-40df-b2a0-56e4d9c5b6b6", "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": "a80afa66-127e-4fde-95f0-1360efe1d4ab", "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": "cad05592-babd-4e03-a8cc-e8bf6c3fa372", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9f0d915-1e8d-4834-ba27-e8429f3cf1a0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9072807-56d7-41a2-b68f-9610a3affde1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b879596f-0cdc-4d1c-b6a7-a4432c723f7d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9a2d47d-5f13-47ab-9e4e-271f985a5729", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "894f0654-9c75-408a-8b69-15e6d23d3ade", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94e39414-39dd-4f46-a8c0-898a7200386d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cfa4ecb-5438-4ae9-bbc7-c721f4a65f24", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "814e980d-95ad-4eb2-8d8c-2d47d62668f3", "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": "custom_fields", "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": "notify_on_sale", "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": "2770cc4f-c42f-4349-86fa-5babcc436e37", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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": "1a5df72e-a130-45a8-b9f1-4192dbd94781", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd01dfdf-e910-49b8-a331-adaa425a27c1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95670195-526a-4ef3-a15f-2c0519470c82", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210cf5b2-162b-4f5d-825d-d896d6ee6677", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36efe2ca-e3a3-4193-9bae-13874645f9f9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a9f912d-03f2-4e04-a788-e79ba161a46b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005ecc95-3cf4-4df9-b554-38577f5d4dd2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225cac84-4741-4c7f-9737-1883efb768a4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "track_leads_days" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b53b85ff-5d20-4b0c-b45f-8c1ce3d99c78", "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": "04f31f71-4681-4f1a-8363-b6373eed2dfb", "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": "d79adec0-a558-4acf-b634-40e82c8115bd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d48dc05-91b7-4d26-af71-ce0ce69b3c4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d74c4fad-5ab4-400e-8fe8-49c04c2bc8e9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "421025ee-a70e-4e14-8bf3-b7e0117fcee0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4637bea1-7caa-4476-9ca8-6d6b57f089cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2543776e-c1b6-420a-8894-bd6fbcb72df5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d32abda-1a82-47f7-9979-0a67912f6bb9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44c58696-75bf-40f6-a3cd-0865126c0853", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ecd3b22-c978-4c14-8861-b18433bab638", "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": "5f8c577f-de3f-47af-bfa7-4570a79e3743", "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": "f8b18680-0116-4c90-ad34-7e294c2c5022", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd9e649e-48b0-4e0f-a4bf-d6088b0a9a94", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6488687-6066-45d2-8ccd-587a8cae52a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c970f5-23a0-45e5-9f83-a88cfb95004e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3629ed8b-5062-47dc-b4c8-41a1c645ac70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81d4111-15c9-4284-b30c-f775a116601e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32a75808-4d35-4c01-a981-786640b74d1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d718254-f818-4af1-abb7-a057f991cfd4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d59cfc1-b95f-4e28-8546-1038cc42dcc5", "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": "352815cf-f5bc-4b75-b85e-394941b70ec3", "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": "6737f864-f21e-4bd9-892c-f314509cc5ec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91c871a4-13b3-4ca5-8954-f00bfed19fb6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65161705-eb23-40fc-83ce-f8bf49145bf1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9e13a3d-d49a-400d-982b-357715ff9f7c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b4dcce0-f83a-4952-885e-633b0843680c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94bc2356-f950-4125-a225-9c6138f76205", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "702ee3e7-c6c5-4909-a7d5-017a050e0e3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b52386e0-92ba-452a-83c8-47fee8715f91", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9dbc4e8e-5d24-4416-9e63-2d83a58d3b05", "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": "43c31a45-9d74-48f5-bc89-b9af46cb2f88", "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": "1b4ea1a9-2340-4a20-b831-50b881df23d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25cc9b15-a6bf-4b3c-a8d4-eace4e3d6e35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ad13ec-de25-45ef-a604-d40d869be0c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33dc113b-83fd-49a5-898e-b0e297e05b5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85c2c45-778c-4531-9873-d28d89e69e39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce434186-0f8e-453f-b553-c94c65cac37f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "431e1656-2520-42da-bc4e-fc1d384861e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bccb545a-7ceb-4397-b2c9-1cc71791b6cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bff1cb2-f49b-46cc-9527-dd2c9cf1bff7", "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": "options", "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": "group_id", "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": "e810abde-8c42-44cc-93db-98d73ca56216", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "49ff9022-2004-4003-b49f-74ea92bcc4f4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a32bb303-54b5-412a-86c3-edf7b1e333ff", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "441d341f-d0c1-46da-92a8-20d62f211ae6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0152600b-73f1-4c00-81dc-d7e1f90369b9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f0832b2-2387-4f9b-9b30-f69b2a0a0bad", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04aeb42a-4f0a-4d48-9f2f-9b2cef31c5a7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1aa0c28-7f17-4fdc-8b72-7d6f5c1753d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feb98ded-12b7-4e98-804f-a6302b7fbf4a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "896bd524-c1e9-410e-9e58-a73b45a466c6", "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": "4b780c14-7383-4061-9373-d35cc04c03c1", "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": "7ace929f-b6eb-4091-83cc-da1128d91770", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f34c599-16d9-4aac-ba02-fd72807fe662", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c951433-e422-4593-9282-18f74910c7eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd45931c-4869-4928-bed1-f46351dda947", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2db52b2-4402-4275-ad65-be34b0a71571", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94527042-4b20-4db6-bff1-d48433cc6570", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caaae3be-1e2c-435e-9864-7d511850b44e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bf6407d-e471-4ccd-a31f-72505e56c281", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f0c9645-faaf-4f95-87bf-c3fb554f5596", "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": "be271ee7-787e-4af6-9ade-7575438f0589", "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": "52dc1971-90a8-4ebc-b4d5-de6792d37454", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6dd60e7-5f0c-438a-9675-c63292b40f9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfdcc3e9-890d-49d2-b837-76fc9fd806ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed90826-3d54-4847-99a1-3425de8700ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba9cf148-9318-4b11-8d04-86e7e9e2b5e2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cad31fd-5754-498c-b3a8-cdd8dee25644", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f8d6fe6-84f5-49a2-a3a9-cf686fe832f3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e42beab0-7af2-4ff5-b945-738a9eddbf96", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03dcb562-e347-4e44-a269-7d4ef7f946f2", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "115a4029-673b-45dd-9e34-b13e506221a8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "cfac5303-a0e0-4b52-af93-405ccb12cc2a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ad57509-fd52-4c95-8a78-9e583606ffc4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb5b4f11-74b6-491c-b70e-fb7efef54627", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb5954d-da78-4ce4-9e3d-1410582e9f6b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "486bc303-fc48-45c7-99a0-13647dab3875", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2c5e95-7266-4fdc-81e7-67b620465110", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df766752-4e83-46f0-a499-c47b028e9d02", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af25ece-3f42-4e09-8bf4-c32ab576a862", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7fc8d08-024a-4c3c-ac6f-9e32dadf9a0d", "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": "05db5968-61c4-4846-b9b3-1f8a40345c06", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55850194-13df-4b39-ad52-6791cbd58eab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b37955c3-4b0b-4ea0-b8e5-d5cb5f26820b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240cb359-dbd5-439e-bb57-6364c0623504", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f781c4dd-7320-4277-add5-23d5b9c5f12d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16064633-b04e-4454-9128-4fda1a46da01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "871f9a10-1904-4d51-a6c9-acbb44ebec91", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8553063-550d-438e-ba10-9ea616419383", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0fc84c6-41c2-48f9-b024-890600af853f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ffe1f63-bace-4df0-9a30-680c47bd6ccb", "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": "7b629355-a0a4-4bf2-b54e-04304b5e1a20", "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": "230ad8be-d7ee-4f2d-9df3-ac469ce30888", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "682cd14f-7870-4379-8b99-acade7fd81a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "901473ba-8df4-48d8-9057-2d9260f02af4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf73380e-5f96-4b2c-8d64-75b9819b4866", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf0c69f-5ab3-44ca-9a8f-e24f404c0995", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526f7df7-fe35-4b88-965c-9c65ad84112b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d89dbe9-6583-452b-a7f9-9e81ebfbed73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "063d6458-b80b-4f4f-83fb-492a04c236bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cffee6a9-8f28-4467-ae6b-07100271ca4b", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3731e6cf-0a39-4099-8bf9-5a5889905625", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f961571d-22f7-42f1-94a8-e8fc22992cc1", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073326e2-e404-4fee-bcfb-6c232ef3ddd4", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78cc5c9c-2c7d-44f8-aaa6-8aeef0833a4d", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf13aed-6e4a-455e-af47-cfa21b50598e", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a53ad62-4a34-4f24-b581-e81e45b23e6d", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f63ff4-ead6-4ff6-baa2-35c519201f01", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dd3643b-8c34-4fde-abf1-8ac0b93b6cca", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2a79bb-c58b-4ed7-906c-91b700fa45d8", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18f31f1c-c313-4ced-822d-397549b814d0", "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": "d35c6862-f5bd-4920-a452-29c49ebeadc8", "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": "3d777c64-d969-4ac5-86b9-77d39050b6ee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1a18e0-0d33-425d-b47e-93f5cff9512d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dad32f2-2d69-4ad9-b5ce-b1a90046bb7f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a726c6c3-9b53-418c-835a-6a57b919b725", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e298e69d-b8cf-4b37-b073-06a71104c2fc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3349233e-af71-4edc-a6f9-b9ed4f513daa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f03c1c3f-20a8-4b0c-b609-8229ec203c67", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c357487-43d5-4642-9e9f-47c3315a793a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f9c7cda-2dd3-4f46-a784-6530fb05a407", "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": "35a2b83a-83af-4267-9e61-cc5f93b50677", "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": "89e1673b-a5f8-4df3-a3cc-064aaaca013c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98075c54-1f19-46b6-92ea-243455d380c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf7ade6-fb7f-4669-a25b-00867872bb02", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2acc91cd-b856-424a-9cc9-4d1be4f09712", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "124e94a5-375f-43d8-a7bf-026a9cecca0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1f45e4-c676-47a3-99c7-7c1d4e69844e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efc2307-263d-46d0-836e-29f70b394398", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb8286d-0fc3-47a6-9dad-4c19aab16835", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "034e386c-0fd8-4237-a9c6-d7721492fffa", "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": "priority", "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": "notes", "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": "23631c2a-a1eb-48af-b8d8-b24d278e7c70", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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": "daf70aeb-74b9-4d8d-bde2-937aab0a7051", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57702cfb-5548-4a9e-951d-42fb4cc2509f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485a53c3-86cd-4426-8360-b567caa17d5b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc754139-ac71-4b34-8d39-04206d19b85e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f8b3e14-74d5-4810-8976-63e51d194023", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc81c3c6-eb79-48e6-a8a0-fac279bb7874", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6195bf86-cf7f-42ae-86b2-2378cb8ce0e8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d74128ea-cdc3-47f0-806d-2174d257f4e0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c270250-edeb-4fdd-b0ca-64ced9272a67", "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": "dc15ad53-a74a-47c3-b743-628b744e345b", "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": "0a6fe73f-8d10-48a9-8933-991bf5f4f793", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ac2b087-3777-4381-ab25-7299b5e41432", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b200fd-b842-4ba7-bf7a-768404d1120f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ae32d70-80cb-4b5b-b9b7-a120b5caea1a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e48d2823-4219-4c03-bc36-d722dc4cf13d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956cb876-ea4f-4d28-bc60-bd482a6c79d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d977a51-c952-4efa-a03f-aa7c8edb2da6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c6ede91-cf11-4087-8233-ddf012308895", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e30143dc-b022-484f-b618-b7eda5adadde", "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": "page_height", "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": "page_width", "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": "d0f40a71-7930-416f-add1-6f0cebf95a3b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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": "fef36775-6c93-487b-9d37-e07bbe8a0d5d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b34ec1-3aaf-4552-a26d-8029e96a4db4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14c78274-9855-4932-a0c9-9c56bea36bca", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6468a311-a34b-407c-af58-3f9adeb9d4a1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ff52497-823b-4beb-ab0d-d3b734ef08f3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0b7745b-4831-49cb-a58c-08c45facff29", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98966cf-f293-4121-8999-8a8d3fb3679e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fde117b9-4d92-42ac-9c27-1b243a2f9fbb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notes" }, { "key": "update_mask", "value": "content_html" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dd44036-d394-4186-b8c7-b0e9d3ffe35a", "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": "af4cabb6-1af9-4b82-9654-dcc30b863361", "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": "cb8d88dc-c7b0-495c-979a-c7976258795c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2702409-515d-4f80-a9b4-d1f80adc9f38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3afa065-849a-4947-aca9-1b9b7b6f09d1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0fb797b-8ad3-4df8-932d-64be798f078f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87d35da1-0a74-45a0-8434-58aae599705f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d468ba27-247b-44ff-b595-ca62e7166a3a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc729e81-13f8-4e50-a851-e64c813c9e35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96dd1661-e349-451b-b03d-43f63ffe0f1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c313264-aa36-4af4-acd8-85cf009b05fd", "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": "921703ad-d99a-4320-b7d9-11a39b60b19e", "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": "b8d6207f-2402-4d74-8796-1aabf4e3573a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc3c8cb-197b-496c-986c-71db9c862213", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb233aae-cc1a-4002-a6d0-42124a0e7cbc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97572565-fcbb-4c0b-8010-d2aeb0a263cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce515eb0-16c1-4071-b3da-5a81a45d8928", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "561ebf54-ea35-4583-87dd-093ca647bd05", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f93e52-f2b9-4d65-a5a9-5e4cfbb02638", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da4465b1-44e5-4884-9dcb-ab28d0cd5a30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47b6c01f-0c4c-487c-8c91-9111514edc7e", "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": "c53056c2-d037-4481-b63f-15ab0ace0e8d", "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": "14aa7a1e-e8f7-4544-aa58-b724862af35d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507ec0ed-b3aa-4b18-a797-47208d791839", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44b8b26-5bc7-4093-ab9e-9ae40f92cc94", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc048e0c-6c67-49a1-aaf9-2a610a6c9dc3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59fe9b9c-49c0-40d0-8420-036c466437ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ce8c19-2a11-40f4-94a6-4032119f8677", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d150ae12-f9a1-482f-8731-83d3fc2ddeba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d9cd78c-eeb3-422f-932a-942d0b4ea5cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "570f3c0b-890d-4685-9d20-7f491e430aa3", "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": "92ee3cfa-308b-4700-b31d-5192fb2bbf6e", "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": "cc3eb8d8-5771-472b-b134-1e8ece1aee11", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0062640-3830-4a19-9b29-24ff91672a9c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a67b5f7-0411-45e1-9442-80501527d71f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aab69a4-2f98-4ec6-b8e4-2408cacb17aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9875ed30-f5e0-4e1e-935f-d413aea4204a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2f7bca-3cb0-4b74-b0bb-80ef8de42437", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6491d20a-d81e-4492-be77-7f733c996518", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7452840-2cee-43dc-b6de-32511bbf5884", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90d90d5b-911d-4b75-8f2c-3076f6b647d5", "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": "8cf18d73-7fb2-4f2c-9d47-8f5e1e89503b", "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": "c96ac2d4-0aca-4772-8324-e150814129a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f6abe9-68ab-40e1-a6a4-a5d171999478", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1824bb9-2191-4bef-a4ce-4a136c087d70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d48f92c5-764e-4d21-be63-1ac6fc44a974", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274bcb8f-c9dc-4fba-bfc4-a8392d696c1a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a62377-311c-4e1e-9dca-3829b6a6d281", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ace17c96-afcd-4d60-9354-bbbd61794b01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e29e848-574b-4c3c-8fa0-546aa29d6d87", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f6aefc9-9dfe-4130-b079-00b66804e2aa", "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": "53b344b2-9947-46cf-bfc1-41d763fe9d92", "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": "fba0c6f1-b59d-46d6-9c28-90557284a71b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f02bd642-4a0c-42b9-9c0f-18d0af6d8d1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3415e12b-50ac-4c24-adae-eb9ee5cc4d50", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f163fadf-a32b-4ef3-84cd-357ac6980ff5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2c97861-5fe2-4c40-b0d8-c4f903211839", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d080f21-d09f-46b5-8d1e-9bd9f6a245c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b991934-1a06-479c-838c-683969939338", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ceeb91-de18-4d3e-b358-b062fb2f09a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "701c445d-2fe2-42c0-aa9f-9aa7b21ed5c8", "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": "ac1a88c3-6a0f-4b3b-b507-58581de27901", "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": "2a759cf3-9688-4d4d-bce3-3c41ac88198d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90061ed2-0e63-4275-b546-130bf8d9bbfc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5ec444a-9292-4027-bef7-bb602317f62d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d26810d3-cc8e-4f2b-a0ee-d405f1c607e8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "860719b4-afcf-4649-a524-bec26c79ca82", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92a1eaf3-9a71-4212-8424-e8dee9712a04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5622703-20be-4454-be5f-ffe420078cde", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c89ad96-a2d6-412f-862a-48ec74b5df7e", "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\": 7566,\n \"message\": \"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": "ad3b8b97-35b2-45c0-8d8b-ed6329eb54bc", "name": "Automation", "description": { "content": "Automation endpoints.", "type": "text/plain" }, "item": [ { "id": "75c0972a-b132-4068-8b4b-85b6bfb46ad9", "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": "281040bb-3860-41ff-b44a-7aacad5d65d4", "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": "38ae641d-761b-4012-9615-8dbab85d0ab4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2387f27e-a002-4193-9b6d-6e3fd42e6ed2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0778e5-7c4a-4716-9c99-3495ec30d036", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7183ea14-eba9-4345-b939-faf1701e6709", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ef067e-a024-4499-87f2-21cde6e680ac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e205b52-ad03-42c0-89cc-4d0be44316cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70c01c5f-a842-465d-8e7c-eeb3e21e18cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "175c2e9d-0551-4695-b9ea-3a1236675fda", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc241bc4-404f-4f97-a362-2675e83bc831", "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": "b395c0e3-d9af-4a44-909a-530a9e0ddc6b", "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\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"ALREADY_IN_SEQUENCE\",\n \"key_2\": \"ALREADY_IN_SEQUENCE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1db8d37-b446-4f18-80bb-eb31f0fca5d1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ae0d8c3-0e1e-4a80-8f65-40830a82b290", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "390e25dc-0e27-473d-9b70-38905a7de06d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b374e4-2233-45ee-b30b-b9fc340616fa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8de076c-b6e7-437f-90a9-74e61872897d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b62833-9581-449c-ade5-4a453ef1704e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa0f52b4-fddb-480e-b261-6b831febd038", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d33d5cd1-9fd6-4e2c-a1fa-f2b95c6a378a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ea5f8fe-e119-4adb-b767-35fb4be597fe", "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": "26c6899c-7f8d-4e92-b0c2-6862ec8656b4", "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": "b6cac52a-d4b6-4258-a611-837902276bac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c0ff336-1985-4cc0-b946-da529a58dcaf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "905d07f8-6aad-4064-a04a-1e82bb2dcca7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e348359-9c20-480b-b117-d0c96e7d06f3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acde1300-5561-4a91-b141-5af1ddcd9845", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6ac4f24-6df6-4053-8940-69fdd6bf8508", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de514d27-15e2-4b4b-bb34-f480aaa0c8e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50e905c1-57d8-4935-8905-435b1ee6cd35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5042fc-5dd7-4312-9a91-f79e84bd5998", "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": "bb1624c8-442c-43de-9104-207f35f4e2b6", "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": "ff9548af-2024-4fb4-92cb-d46a6128ddac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca3b91e-a09a-4b91-8b4d-c76300985c9e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d680d3-f983-4f2b-9c94-a89f19bb4d93", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da19c0e4-00b2-4bf0-b278-c21cb88da352", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfabbb7e-9b29-4fbf-848d-cae4facbe21e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e479f684-7b24-4276-9095-b18ee6f41b24", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a075c274-29f1-4c23-81c4-d0e99ad749e8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a2d80e-c83a-4aa6-88bf-5613d019a01e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd8314d3-3121-4344-bbc8-9c77b1190ec7", "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": "69a10b2f-d49b-4b99-8e6d-f8c8644b5546", "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": "e5b61898-2ba9-4a2b-87b6-4288947dd9f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e6c68c-6118-4776-a8ca-720a2bc6b0f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f5f1b5a-8060-41f3-a8f5-d66f0ec54489", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bcf0123-f280-4cfd-89e4-5576627310f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8dccf54-b6f4-4e23-b45f-5f6a26fe7fd5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8d786a1-09be-4115-bbcc-44134663e3b3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af0c9962-975c-4a56-9af1-8aa985df78c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6effa293-decf-4f4e-ba32-66259f72a908", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "801efe04-7ff9-43be-8e91-c409f244258d", "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": "d464f79d-6d57-4da2-8d7c-0eb1e653d4f7", "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": "48fb34b2-9051-4c99-bdfd-5d065191250d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd2532d9-ddb5-4d98-95be-a14b1832e0b0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "237993c9-4188-4962-ab43-29d8dd86eedb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8aabb01-c43c-4da9-8565-b040e7049cb8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a79f53f-14cf-4ada-8e41-f38dc588c5dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33cf10d1-8436-48d1-be40-22f864735df4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4327ae7f-3fe4-496e-9866-ad5e9e76d52d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66bbbab1-0774-4dd5-9aa0-e606df6e561d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fcef22b-1ec5-4c27-ad2b-942a91c50c5f", "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": "bb0adad4-9514-45dc-ac16-ae4d1d4988e8", "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\": 6966\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "577964f1-da51-463d-a2a5-f2f079369800", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d1c45e0-f962-4dfb-bbad-4f67b3816a7b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4188f886-4f28-449d-9cc2-cdaaa085b55b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee547cc7-10bb-41be-95b5-464447c97f48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97a572c7-ef13-4a11-a972-e634fb258bcd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01170219-de3c-46a3-bcb0-7cfab6f3b48e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b9b241f-2710-4c84-a1ac-9085d86174d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30853c71-2067-411a-b98c-757171c80cfd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1254543d-bfa5-4998-b3e4-2dfd6abe69e3", "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": "3658", "description": "(Required) " }, { "disabled": false, "key": "automation_ids", "value": "9241", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e5183515-7f3e-41a5-a38f-10f319ef8396", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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": "e94ec6a5-9f3a-4cc5-9da1-dea52e223978", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4866c621-1f64-455b-8146-6da057f010e7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ae8fa0f-dfc0-4b93-a873-75f0a79aadf4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5155fd1f-7557-4904-a516-96c706caa09b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e8c0795-f7ba-4702-8db1-56ba0e319a9f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee1dd36-ca08-4319-9de9-c1ea73c0f9e5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e016d471-eb20-422f-adbf-dedda0045835", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e3208e-0dde-4027-9347-8d96d8dcf166", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "307" }, { "key": "automation_ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32c0a570-fcb4-44a4-b5ee-3182e9146e93", "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": "3609103b-9ef6-417c-9950-bfe1dc24b40e", "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": "4493204e-986b-4bf3-b102-e6aa27863c1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f090a86e-6d8a-43ef-a5a1-a6faa19852dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb463fd-596d-4bda-81dc-b8a820f27b00", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1d17a3c-6355-4e64-8bd4-aa46ae28ad18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad9664fc-8662-4b66-b158-8577cac45fe5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65f741de-d7a5-465f-b1e6-ca83907c61c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08fd7c75-5b98-4909-9488-13ac7fb445d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f019c07e-33c5-4424-9cce-6d4cb432ba67", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfeb736b-705a-4be3-9b17-c0849c7cc1bb", "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": "5a21a789-51b7-4b3d-8e45-f94dd32e3cb9", "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": "b18837f9-a2f3-4c63-b821-d69ced31b1da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0ba02f8-d6b4-4c5a-8f98-4824a2df32dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff53a1ea-df63-472e-a4c9-3a4bf7f64f6f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e89a4b6-2fe6-4738-b297-fcfa7aa0ce72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bac39e0-3cfd-4ed1-85d6-ee260602ffac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f99c93a-9c78-4ba3-b865-45ed4e01ca3e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c886e85f-1778-4098-890e-21a56c87b42e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d548938-1801-4896-b1c3-7fb21117d09d", "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\": 7566,\n \"message\": \"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": "e6d4c771-af3c-4605-aabb-2d399fad33d2", "name": "AutomationCategory", "description": { "content": "AutomationCategory endpoints.", "type": "text/plain" }, "item": [ { "id": "2b8292d8-5916-4225-8a15-e6aced45cf28", "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": "1a83919b-16cd-40bb-aca9-a3a7f791a0e1", "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": "2256ade7-06e6-41da-a812-8ac166ad8d35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c34d8a9-ed53-472c-b6ff-7a1e9813a92b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ba6671-cff6-4458-8f5b-58bb538f4857", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99eedb58-2156-4f08-a75e-d3d797e763e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4aa4889-155c-477b-952b-11e63677141a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ac4810a-a619-4db6-b1c9-bf5826166331", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31396da5-8e09-4565-b657-9ff4f1c5882c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b19bf7-17aa-43fe-8cdd-9d2e6b0c6173", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aaf16faa-0de7-469b-88b8-bd8f27fb64f0", "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": "3db90ba1-9a9b-4690-9067-f5a151b071bb", "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": "6810e3d4-9a8f-4f2e-bae7-7c62fb220d47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c57dcca0-556b-4ff6-a229-f64b3751983e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f07e6c6-e3ba-4cdd-a2d7-311169d62ade", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56aa620f-a4b2-4ab2-aa1f-4f295820ad6d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b3dc7d-98ab-4740-b7c2-de6e86e6208f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9588cee2-2cc3-49a4-99a2-86f29c7b87c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8906d4a5-45a6-42e8-bcf8-d99b20d7d84a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f60fcfcc-2011-45ff-ac3c-d7424f243021", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "571091f0-2dc0-4773-ac17-9420bac96ce8", "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": "3658", "description": "(Required) " }, { "disabled": false, "key": "ids", "value": "9241", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8bead1b7-52c7-4361-8fa6-e23a60d4775e", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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": "3d4a3f53-abd7-4b1a-97d9-23e818513d85", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd29f04a-7510-4f6c-ae73-6678e727162e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b49d151-4329-4178-a2f4-351e85873b84", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eecdc9f-4c4d-45c3-afda-a6ef1b19b0dc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff22dcd8-27d6-46b2-8885-f12d17da5104", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0ca67c5-e6a7-4eb9-abf8-d1af86ef0da8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc93556e-3d78-48f7-bb7d-f4034299d3ba", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c86821-f899-491a-9ab1-ac8008bec427", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "307" }, { "key": "ids", "value": "940" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7004cbaf-e7c1-433b-832a-a83cf74ea1ed", "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": "41af284e-7107-4c3b-ade4-cd423774eec0", "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": "c9bd8f6e-e7d8-429a-9987-6e2df123a595", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f8d91d6-8a1c-4b19-9fda-8c0ea9a2fb8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274808da-2e9a-4238-9e9b-f0416e21c668", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60aeaa82-55a9-4593-9a0d-56261c5dc1e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628b3ce4-305b-49ab-acab-6429dff9c305", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1809f14-5b8e-4641-9983-8fd53c4f1825", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f841ddb1-498a-46a5-ac38-4aa53df2a4b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d4c071e-6dbe-48b2-958a-d674c591cc13", "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\": 7566,\n \"message\": \"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": "d5d2fe56-f63a-4e85-b68b-719ea1a20caf", "name": "Business Profile", "description": { "content": "Business Profile endpoints.", "type": "text/plain" }, "item": [ { "id": "7e7fcefb-023d-4aa5-ae46-c073bc51da3e", "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": "0cd7a3f6-6aa2-470a-bb6e-d054c44a7905", "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": "928713b5-c0a2-4188-b401-fe3c364fc600", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b06d7ae-90a0-4d70-98f1-982349b983c4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "925071af-c044-481f-a524-1ff00d56d7b5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aa323db-a46c-4fce-8cf0-4c7af1e6589c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b10a84f2-f394-4421-ab37-eeb3beecca90", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4922cadb-17f3-4951-aa84-6018b788d0d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02b0c99b-2dab-47d0-9ddc-c5571e05b526", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd20af21-d923-4e1f-aab6-93cba649ba2e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6837f96-52d9-49d1-be7c-1c9dbf867054", "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": "5b00efcc-9c3a-4b63-b93d-7b7abc6c2d67", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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": "fbb8f1d5-bcfb-4418-abee-da37d1f12262", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea5092aa-10f0-47e5-adf8-f26a8125b879", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ffb9d26-682d-4b9c-81ba-c650f2fa5a4c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95a46d5d-63e1-4e0c-a72d-e4d46eda9846", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06691387-400e-49de-87e1-e1a6da6775a9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0c7e3c7-cefc-4960-822d-91f92542c597", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113a0d58-75a9-4d95-b28b-57f9446f6968", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30dc166b-7f5f-49db-96ea-e13cdb7f008f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_primary_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\": 7566,\n \"message\": \"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": "02a17960-4b4a-4534-aa5c-65421cd5b9a9", "name": "Campaign", "description": { "content": "Campaign endpoints.", "type": "text/plain" }, "item": [ { "id": "eb149bf6-c1e5-4dbc-b4fb-cae492970bbb", "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": "cacdb39b-4fc9-42ca-9a1e-82c1231e4a83", "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\": \"FAILED\",\n \"key_1\": \"FAILED\",\n \"key_2\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_3\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4e0e85-db15-4f62-b225-e15f3af62a6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a68619c3-c5be-490b-8b1a-c8c694aeb895", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca14bfd5-4fd2-49ab-84ae-73c21a46b096", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e55d847-fb15-4613-b2c2-8622036070c6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bb539d7-5a43-4c0e-9f86-98506b329858", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0638bed7-c7e2-4f90-b47d-5744ae49d8ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a99684-962d-42c6-a7aa-7e927a6e39e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a167905b-4001-4c95-880e-e9d176600bfb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5fb0f4c-3492-493a-abd8-2546c1fcd21e", "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": "5542f19c-0f25-43cd-8bf4-927cda265c18", "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\": \"FAILED\",\n \"key_1\": \"CONTACT_DOES_NOT_EXIST\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e14241-9b31-4a0c-80a9-07efd6e1c9a0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e263cdad-e933-411c-a6fc-8f9544b7a70a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64eb2006-be0e-436b-981c-7a94eac06f95", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f16fd02-5fab-4289-a57d-052a9ed97ff0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca80287-3524-474f-b485-a099982febe8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce1107a2-b959-448f-b3dd-b161b8737585", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cbd381f-8d68-4696-8007-d6709b87116c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59622bb2-7971-431b-8ea1-629394fa5cb5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78d6512e-856c-4573-8745-2afc4af7976d", "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": "73e86807-bce5-444e-bd46-c29ae79865ea", "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": "ffecff48-9e43-4c59-80c3-dfe568e3030d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de21ba66-ebd2-49be-b68c-e6a9d9e5e61f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4e827b-45d0-4261-8156-52eaa2cc3e5d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7445357a-4be2-4af6-af7b-fd8732f2a5cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2791eebc-c562-43a4-a53a-6ae28a24f10e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c044158-6970-45ed-9843-25586e978a21", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa23e8c-76f0-43a5-a639-dd4c7e399ade", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4386a4-62d6-4d4d-bf28-9255ae7b14a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2127620-3980-4a53-ae5a-ebaabaf34441", "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": "5870a298-3778-4247-be17-3fe5ba52fe51", "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": "93a9f438-e0ee-4487-951b-a82b56446d07", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a60de4-f13a-4f2e-9b4b-8d1e48b3cb92", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8d580c-7508-44eb-a6ab-fb523371c001", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ac8d0e-0a36-4c5a-b557-2290b8e7c8c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88e1d2e0-ba2c-4133-bf5e-6ff00084e6f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "278019f3-9ed3-4d2e-8a45-bead48f2461c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ff6244d-1561-4f8e-bafb-34960e2b4bf8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3732ed0a-b5d2-49de-b313-7d73522821ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89917af7-8e24-460b-863d-7d09073353e7", "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": "b950f98d-051e-44f7-8edf-1fee50b41c90", "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": "e201d1cd-8b12-4002-b291-558139b2bdba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "055a5f90-41bd-4a0d-952e-421ea65da158", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74b49bac-ca93-4813-b63a-07324df57ad3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0758bde-e841-43f9-b912-135409ee9c0b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "687490b8-8322-4d0a-bf25-03d69374f0dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d2e32d-3bf0-4e41-ad49-10075928fa58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ceb408a-0c84-4eed-9d2c-94caf30c2f26", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa445e36-6286-4150-a32b-5c04ac72cf61", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ede0464-e63c-4afd-8699-959229999eba", "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": "2db5010a-fd49-4bfa-8b84-5cad9dd3184d", "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": "89b9f76e-c051-45f4-9e31-0abd36e1e0c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96ff15de-02eb-4ab3-9cd9-4d9566583a88", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b29faa-1db1-4ba1-866c-599f0123fb39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a39afb2-fca9-423d-a5d0-346c3a79533f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d31436b-0c72-489d-86d5-ac95c257d8ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f7a3064-e71d-429f-9278-1f489da4e265", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd2c88c2-8e83-4bca-883d-9afed8ce5e9e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9382d953-9cb6-47b8-936c-3557ba5a55e4", "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\": 7566,\n \"message\": \"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": "fc86b450-5ada-4917-9700-3d856134654d", "name": "Category Discounts", "description": { "content": "Category Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "b04027a7-a419-4312-b9cd-6063d98998f0", "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": "61740a7a-5342-4134-8056-70843d83495c", "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": "bff864b2-b82c-4bdb-abcf-ef82ae88eb94", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc55d909-fa4f-49a4-b37e-35fadff727a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f643c87d-b576-4227-a87b-844b19470db3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a313133c-f11f-4b7e-9918-f9dbb579445b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c7b5cb-546e-4e0d-9332-c0d5565aa547", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1026d1ea-078b-40dd-808a-41b023a9d502", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8430d7a-8740-438e-aed0-691c1bc00178", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4d55dbc-73a5-4248-a8fa-5f20956cabb3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4047ab6c-3d01-43a2-93de-05fc17b16b14", "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": "9917effe-cdc0-412e-a538-906220f526f0", "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": "277cb514-04bf-4ec9-9967-8a42a1d006eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b82edb3d-17db-4ac3-abff-8b67756e2e6b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02603ed4-6a35-4356-9903-314fbf74e95a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad7f06f-97d3-4d2d-980e-556a37074ac2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "999af8fb-17d3-4bb4-bb39-1d2e1632f4b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cde4082-ba31-454c-8627-4162698e6234", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ea47c3-2238-4b77-a34f-fe5a6792f5e8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aab7e27-dff2-4ece-a3b2-c7b5a3075c4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6746af95-1b1d-4a66-84da-13dac388c1d6", "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": "43e8a204-6938-4f81-8ce8-d2ef286ff06d", "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": "0e6b5962-4d4c-4eb6-948a-e5ade46ea612", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57fe6bdd-26b8-4321-bba9-6cbc7a93681a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4d9569b-5334-4ff6-98a2-43be8660488c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f302e03-0962-485a-b1db-16ec83626568", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41ce88fd-3b99-41a5-a3bb-78966d73740a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc26a893-56cd-46f0-9569-4af3eef47e1e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62c6d47d-adf5-4ed1-8c6e-3978baaba542", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63ee8189-77b3-4060-a511-de5eac9c941f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a692a26-e423-4985-aa16-fb5d03065537", "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": "f363ee1b-fe53-44aa-a87e-f07ebaef09b5", "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": "cf290264-c2c6-4c0e-aab7-0b19b45d0418", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc405d1-7769-466a-ad59-360f7815b500", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f6cbcbf-1453-4235-a016-aece2441924d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea45702f-258e-4699-909f-48f246186e90", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64d6b0f8-5f9f-4d28-8805-e5d07874c8d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "159a4043-79a6-4479-854b-5153b4f50cd9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "702c5e18-cc6a-4ece-8113-e489150d8145", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1778a9e9-86be-4f88-8f12-9d601ba1e78c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b31b0ae2-26e8-41a2-85f1-2f0d93bbd1b6", "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": "48d7bd45-2420-48f6-83ce-086a120dfe85", "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": "82835537-df0e-411e-bdec-9cb41df7d5bb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e585377a-d51f-4d67-8582-c89a0c2bc70c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb7e133d-0ae8-4e9a-accd-eb66ada065d1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05b9480e-4ab5-4560-9efb-6fbe76a6101e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa2808c-8e31-455d-9087-eee3b692cc58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb28195a-133c-4072-942a-00f5b7dafbce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "989f7366-6a19-46c0-b788-962ebc9bd9b3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1e78726-664a-481b-917e-b114e7753e2b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5a9465b-aa42-4e46-bf48-a1dec29400df", "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": "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": "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": "a7756d2a-e643-4bb9-a976-09e0aa2d06b4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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": "cdc2b603-d03d-436c-8e28-f88164983d9b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5eeccc2-d4fa-4ab6-810f-96d200e7c34f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a98c59e-51ea-4696-b5ba-447b04871ec1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bab38e6-5e68-4f6e-bd04-328919158b70", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a8099bd-893a-4e7a-a6f3-32b14144ad55", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c251aac-901f-4bd3-b58f-5345f8f09a7c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce9691c4-c788-4b08-925d-7feb02f38c93", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12027d47-0054-4c58-9a58-3b5594954342", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "apply_to_commissions" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2965a60-b505-4fb6-9017-813d03470972", "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": "0f2169c9-a509-4a14-9037-3b20517a68c3", "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": "6d7d1ed5-8d76-45b3-8dfc-ff82897bda84", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "815cfd06-229e-40cc-85e8-33e82fbdad58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "208ed962-9c14-440c-b51a-9d6c37f9a745", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9284f11f-76f9-424d-8e0a-028c3eb0ae98", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47e78f20-314c-4663-b217-fe864af3bbfd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e404994-1865-420f-8b3e-c20c7f1f173b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "638dcb7e-445f-4c64-bc9b-e120d536dfbd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed322d11-515a-4e44-a2a9-cc32c787e05f", "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\": 7566,\n \"message\": \"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": "a9bfc28b-ab30-4b52-a9bf-cee883208cd4", "name": "Company", "description": { "content": "Company endpoints.", "type": "text/plain" }, "item": [ { "id": "caffa08e-b6fb-4ddd-8f93-b1925692995d", "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": "dcc89979-3465-42a6-9e6d-af489bac34a3", "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": "742e4096-d6f9-4287-8e0c-db1b0087e06b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e406c3f-da14-408b-972c-27eb0aa64c5d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73475324-4d00-4918-ac18-e065d28328d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a86206e-9cc2-4184-b9e3-f675b946fc14", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6217a458-6714-4467-96bf-e0000dd03f7f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e3a70ab-cf9d-4161-ad16-8769f7ff383d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "360d7fba-c874-45f3-8f27-0d8dff9fa78a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a01ca98-f151-4bda-9639-29b5c784d799", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94685702-ecc9-41be-9c83-5e06945a9792", "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": "2ce8fefe-0a7f-46c7-8bcc-0b0c775f91ca", "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": "7b1fac9c-78c8-4c33-be9f-84a7be6c4d37", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36dc6a90-308b-4f98-ab34-b7138fd9ed86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396078c7-b461-4825-a591-88db9b186584", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15fcc8c6-422d-4fb3-a0fc-4ce1813ceda2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfea5d00-d6b6-48cf-88d7-b839eca8d7d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83f1099c-b037-40e7-b8cd-95dddb752b7c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425dcb49-6f35-4868-bcb3-25a1838b0f74", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "961e4bda-ddff-4de8-b372-5970730a2eaa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56bc70af-9541-4e50-aeb9-5e1e83912d3d", "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": "d2062847-6b2b-4ca3-9f08-5719312c6ba3", "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": "6bc88588-e33f-4878-b179-6a623ab5ec15", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5802d1c4-bc05-4e97-9e77-1a16eb7a75de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6561ad00-5c00-4e4e-980b-7604414cc704", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0805d173-2201-44fe-8360-cdefbe6399f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ee24c28-c88d-4d60-9544-8896bb6a2b8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d131ff22-6927-416d-b559-1d447135c85c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f799a6-d440-411a-8570-b009622e71f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d10aa854-43be-4ec9-a3bd-612a03b4fe11", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fbc436c-a3cd-4e23-bed3-775be0ceea30", "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": "b69e6ee5-2ac0-473c-bbe4-c7e8cff33fb9", "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": "012eda3a-18ff-4c25-a2e6-a522d17aed6c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d6e44f7-6fb2-47ef-ab66-bfaee09d427d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462a8d7b-6543-4f43-b790-cf4e5bffd5ef", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb2bb71-5ded-4ddc-bf1d-eded867922e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "640eb4ad-d148-493f-9e63-1dae5828c230", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b850e95c-4744-443c-9875-93a94aee70ef", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59231f0-6d65-4302-8c8a-71b6f3fea09a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95ace5b1-714b-4b08-843e-06218d14e780", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "203a765d-16bb-4fd1-b265-05bd945ff7bc", "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\": \"WHOLE_NUMBER\",\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": "8be48885-a92f-46e1-a3cf-e89af6aa9a85", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "f129572a-fe03-434b-adac-9d2b56796119", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2f94650-4a48-466b-8bf6-582de2f7954b", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86204f8a-e984-4bbd-b6f2-86e8c79f9b50", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb80889-f9c5-4a9d-93ef-b0a81e991ca0", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe32639f-9a5e-4dbe-b686-42d28dfe65e1", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f17a295-66c0-450e-8e87-f8b869df2985", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e40a663a-e830-453e-abea-2e8884232a54", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408a1259-a1dd-4f29-81e7-f86c33855500", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "303988f6-9418-4d9f-b482-ae552d3357d2", "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": "b65870ce-71e7-4ea0-a40b-abc23bbed046", "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": "aefc7835-d50a-43c8-8a88-3c1d78d4d3c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd792eb-d373-4509-9bbc-99809ec3bf44", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edded5ef-2d92-4dda-a0ff-3f415a7de443", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a3562de-d1a6-4925-8ed6-0ccd07370c72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d833c393-39fe-4fef-958b-9fdb39a196fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d7f413a-19d4-4a06-a2b1-601416fac0fa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aba815b3-d35a-4a23-83b4-50e5273a79ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cef15c7d-18ce-4d6b-8c11-df86756a683a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f3c40a5-b500-4a10-bc37-c568921320cf", "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": "5e3cd4b8-60c2-4f7d-9b51-cbc73ee64ad7", "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": "87cb7479-cdd8-479d-a043-ccd36ec2281d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf5269f6-990a-4301-ab15-4ca20860e7fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "715a960d-9950-4070-8594-05dbc7abb6f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8061e1eb-f453-4fee-9033-71ce10fde3e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae12ca20-a153-4ac8-a15b-9daa7bfd5199", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6fb71b4-1686-4250-9c3f-8af30215a8cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d27c5bc-869f-4f8e-9603-0608918bca71", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a190bd-ba1c-4a2f-a1c0-6b20beafd008", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35464eb0-b41f-4fb6-85e0-ab306e711312", "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": "38a87b33-a5c7-44f8-b05a-80ee17ab9386", "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": "e2b3ed60-5be6-4881-b351-d15f35d58c53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1df594f-f21a-4cd7-861f-903672e00233", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa290939-52b9-42a6-8507-94669f5c67a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae9fdbca-dfc0-40c7-9f67-b6e78a0f7d5d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b232d24-3260-49ae-9ce6-9b8b0c8fb5b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e8575fc-fa76-47b0-b008-03e52a1ed30f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cbca83a-4419-4b2a-ad4a-5b850649c689", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b937ea04-f945-4a8e-85ef-1716a7f434ea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8dec337-5120-44b7-ac3e-d3f079f38a4a", "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": "621dea7c-9ca9-4832-a767-3048667d99af", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cdeb126-324e-4b35-9863-e69106a18a4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e7978d-ca3d-4687-8a22-23307d05d964", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7162255-d733-4e1c-824f-8f08d876f79c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f1a458-4471-4c29-b04c-cc8321a60de8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06a4ef1-7bf8-4ae3-b1cc-bfd0e6de324a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bccdacc-7f76-4364-9e63-a39f56551f1f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d97874b-4b8c-4d7a-8945-dfcf3975781b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b13e74b7-2915-4384-b107-4ac97ef0319a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8b5158f-8985-4e46-8ac4-00d46be3fa43", "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": "87517b00-d2d4-47d9-a143-9d146d14c193", "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": "521861f3-b7ea-492b-b7b5-d2407ccd6ea4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6853250b-edfd-413c-a192-29d7c878e26e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb7eb42-8212-49c7-a46f-d57868f198c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a23e022-9928-4aec-a5ab-40b061c08906", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "162ab2b9-c85e-43ae-b5ab-fef0f8606d2c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63610c7a-8447-4fde-996e-a97dded44fd4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01392fdd-ece0-4d53-a05a-c3acdd9210f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efbc2ea9-09c5-464d-a7e5-8b4f6147a576", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e51ed213-6295-4a91-8da8-f7cafe9155f5", "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": "fbfaf7a3-04c3-459e-8134-40b5c8e542cc", "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": "7c4f0110-29f4-479e-926f-966ecb74c0a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70a11027-74c5-46e2-b534-e999c084c017", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9997d2a5-9d5b-482b-9f91-a8e940f6e763", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f52740f-757c-4534-bf83-7bbeaadea02f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a41107-ed0e-4e4c-88bf-9a033c6d2af3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9de265cf-a0fc-4437-99d8-9662eb4611d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "039b6389-7705-486a-ad72-936980876912", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45e8e223-f07e-41da-8ff9-a667cbcd779f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d7e6d3f-aefa-4df3-8d1c-3afd6c26cf91", "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": "custom_fields", "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": "referral_code", "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": "3ce295fd-bb71-4e71-8083-fed27bc6b68d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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": "ceec6dc5-55af-441b-9ef1-2f72ce18dc38", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4691040d-400e-441f-9e3c-998c19511432", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4419adc1-9dc2-49ca-ba5f-51c38a1e7f93", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07245a32-4421-45d6-a640-9b68df501380", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7897331-6f2c-47c5-afe2-d3c79796778a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5820d11a-4d85-4c81-aa4a-ad810438c580", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73751e80-2051-47d9-a5c2-b06afdb109a6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f12049-6456-4618-ad9a-be8cf5d28d6a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "phone_number" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "106d5189-f338-4d93-85f4-0feb62c82764", "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": "9fb7801c-4387-4fdd-a657-23494f2d7415", "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": "6026403c-b0b8-4679-984d-14690d2e7533", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed7beaf-5cfb-4914-a171-f02fb404382d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4436dc87-5760-48e9-ac59-a24186038ad7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93c95db-08f3-4c58-a41e-0c13e091f57a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53dbfdd-6f62-4b6a-9305-9430f5160f78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248e1f11-a20b-4b73-8eed-dd190fc265aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b1aa779-d027-4a8a-9152-bfe8eae713f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5470bc33-50eb-4b58-b0a0-00469fcb638e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3e88f67-12d4-4c86-a8f2-2546fb933684", "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": "options", "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": "group_id", "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": "50e82190-e4ce-444f-a7ae-dc8ce1515ca9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "891d5898-ee1c-449b-bed4-a6df82ef1bf7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e29b3c3-d7a8-4557-8506-82aad29777a2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdfe0d58-5c0d-4ed5-8301-e09a5ae302ad", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a8881eb-9eb8-4d7f-9d5d-f250335834a4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3accb8b4-91f8-4f84-a63c-15f4ea5242d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45cabd3a-a42d-4a38-9cf2-c97711c4c0ce", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "494ebff4-2283-422e-ab1b-528b498e8886", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bf99566-aa70-4470-ad31-622837550455", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc081524-232e-4b41-88ef-a2563483cf0e", "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": "a5bfb405-8c05-4232-b8be-11cd3a1c05a6", "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": "870dfd07-39c5-405e-9c8c-27d6473d208c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249626e0-dd6f-43b7-950b-fc2905a88d75", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f96efca-cf71-4d74-90a7-79f6df07f2ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "847c9c25-c0d6-43b4-9ebe-2c2f45bf1181", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf13106-5f18-43ff-aed4-767ce8fc22b0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a10450e0-44be-4c1d-80f0-ded20c1795aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b1da373-ef03-49eb-8bb0-07c0923b535e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f6f2e3-bbab-408a-b797-e264c468359c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7539ffe-fa1a-41c9-abcd-c28ab8044ead", "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": "36c13c69-fe3f-4b7c-908a-c4d0bfe48b1a", "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": "5726eb4b-49be-4860-8286-d5b2f3fd5103", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "661a206b-294e-4c17-89c2-3568b718bdb3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8328587d-f9cd-405d-8989-87976b2e6473", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e04af14a-c0f5-49ba-a2e9-16218ce37743", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd253a4c-cf53-456b-a9b1-3dc98ed4c5dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4b1625-cdb3-4deb-a95b-4d22421083f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c734b94-9ae1-4725-94ab-e5d1fdf00afe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "298141af-3313-4feb-a26e-c4e8e2d1d765", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "022ed13a-4345-4040-a23f-58747644dac2", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e824543c-79a0-4a53-9971-8ecc7e17b563", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "ea252e0d-8ff5-4308-a8f6-51c9e0a8936f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c1cbd1f-6465-4759-879c-975abca51291", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd855ee-69a5-46d2-a59d-7d351ecd0a96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe02f4eb-7825-42f0-8715-b6e3df82baff", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "039aae2c-478c-4389-b25a-13c0f2448c1f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23e23b1-1209-49b8-bd41-9e03e540947c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cf66f0e-e71a-4ffb-9774-3378746ee48f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee06bf21-e07e-458e-8f88-af98c09222d7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf97dea5-11cc-47c6-8631-ca533f622234", "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": "a4287cd3-cecd-430c-b211-0fbae4a97f0b", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d4b6cf2-cb61-41e1-b437-7710d672a728", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "491e1982-8d34-46f5-abbb-f009485b9cc4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f22299-6d1e-4eed-ad5d-37cf9ab6a15d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d3930c4-b5f1-47d6-8845-632065ca9daa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1703490e-8499-4c2a-98ca-78ff730ec47d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ef4eb5e-807a-401b-bcbe-0bd66f4adec8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93bd0a0d-70e9-475e-a3ef-b5ba4edde7c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d72cb030-83ee-4fbc-b271-1991147b1458", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ab92843-244c-4b80-bdc7-51b552e532ad", "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": "56e7c429-cff6-4ed0-965f-b077aefa6f28", "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": "6c8aeb29-3d46-4f23-9304-b86167880f28", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b32a73-47df-4779-9076-4ed1aca6fe1d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a86dd2-8fb8-401a-baf8-8b3c9cc31cde", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f78ea23-73b6-40d6-80e4-3f4e39dad997", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d8ca04-d33a-4357-bdf1-f125802c172f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9975e114-f342-4c3c-aeec-03ac378d5886", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70cdd45a-0234-4bac-9e00-7e7045eb778e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2146d68-b261-4be5-9401-1b4504d9bf4d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f92ea31-b130-49aa-ba06-d7f91e438f23", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b89ac1e2-43de-4df0-aa1f-0c30a029ab39", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24f8d07-9f04-4afe-8ddc-cee6f7c5f04c", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62e6b89-a487-4ec0-9deb-0cbaac09e467", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00c910e-ace1-4996-9d5d-0caaab4b4552", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3fb316-9f8f-43d9-ace0-0cda1952f0d7", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e263fe91-eb85-4ae8-81e8-afb550ee114d", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "325dade4-9742-47e4-863d-d013eeec6f3c", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa51e74b-ae85-402f-8e08-abdadb34272f", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e13ff78-6bd7-4137-b8c8-4bda8b8ec2d8", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d67a4dfb-a2e3-4516-bd41-d1e1cd0206c5", "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": "1f0850a4-d58f-41e9-8324-072c9144be73", "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": "2722af25-23be-4cb5-9976-109a620c52d1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "036e7435-0546-4516-bafa-366e34393b3c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a003bd8-2b23-4f90-bb9d-fc1b9567db4a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9fc609c-66d6-47f3-b8b8-727fd45c3d41", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b439ccff-a327-4d6a-9281-cf229aa52323", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c9fd36-f4d9-43a2-9a32-a7f944efe14d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64493b60-811f-4032-a9b0-845ece448c58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07ca46d-9793-4e6a-ade8-ed19104bfd64", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6014978c-60ba-4462-b2f0-c15fbfd2c51f", "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": "a7fd5956-b68c-4403-b7c5-a846aa7fb631", "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": "f1b705fd-b2a7-4d29-b92d-c822736a87ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5231ad66-2812-4de6-9c0f-e58f4a0e868c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d982cb02-d6be-4b76-a8d8-5e9cf6c3ba22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24beea2-50bf-4fe9-882d-19b38dc482d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5426f700-2c34-4ed4-9ea3-fc9aea0cb981", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342dc349-91de-49f4-90bd-e2a27df993f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb24cb44-ec93-4f30-ad65-2de9c06f5c17", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a03d5c7-69a3-414e-8636-054b3a08d6e1", "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\": 7566,\n \"message\": \"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": "1469c43c-2ac0-4b77-8f15-a17fccf4bb96", "name": "Contact", "description": { "content": "Contact endpoints.", "type": "text/plain" }, "item": [ { "id": "f74a4c34-d3c3-4821-9843-dff64ac37a28", "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": "8ced0e36-9589-4421-8e22-cbbe57d48eb1", "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": "2fcb43cf-14ed-4b88-be87-9a40c037f79e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05d2417b-fe19-4d3c-9f4a-0fd40a4f98e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd4e497-ca29-4781-9520-63d8b05c036c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9306799-7df4-43b3-a040-a3ee7a21fb95", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd7fac27-00e8-4aae-93bd-8db603729c8d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d9118c0-0980-4c4c-a20e-e49d4ca47b11", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0319d11e-5d97-406c-87f7-451d5e5c7ad7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53095ad9-659d-47b5-9ec1-75e1447bbdb8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f226b1f-afc1-44d7-95fe-ae1948af5bb5", "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": "EmailAndNameAndCompany", "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\": \"FORM_API_HOSTED\",\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": "d5b96468-6c33-4720-bf4a-f4f0b2b7cfeb", "name": "OK - existing contact updated", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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": "89bd5110-5dfa-41a4-811c-d395d3bbb91a", "name": "Created - new contact created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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": "4cd557db-49a9-4e1d-b1ec-4122e76783dc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70aff17b-2f08-486b-9221-973e6b8b068c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5782036-4ca9-4b0d-a2f3-3feff0d1272f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15acdd56-50ae-4448-81aa-ef0e51677900", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4f36f65-a60f-4d0a-8179-2b4f9766eea8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dc4e833-7485-4e19-bff9-5bb48d53ec87", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "282be9ad-24f7-4d0e-af1b-2d5370d4bf99", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d8477da-ccf7-4e66-9e66-a99e33c88f77", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42ef7a5d-92fc-4562-99fb-abfa7a8f65ed", "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": "4bec8208-da53-4f7a-a910-824705688d95", "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": "9a3331b1-4c80-4ad6-8897-9f1b5eb2681c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd675403-233f-4314-982a-025996ff55a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d10e9c0f-ab10-423d-aa6e-f93762540bbb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ded9b2-1c96-4273-bb84-143cb0c9febc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e107f54-bb92-41fe-8264-a2a68a6ac9f9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b05354-18dd-4848-b85a-7b7935e1bb9a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6edede3-9276-407c-b4f4-f8ef3b089fc4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcdc25cc-c63a-41b8-a044-44a3886a137c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86ad03da-0fdf-4612-b913-b54989673873", "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": "f7a8e528-181f-4cc2-b6f2-9963b3903df1", "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": "7d8d2867-dca2-4c6d-9b81-74cd0aa806f8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3832c733-2266-459e-b3d9-93f5b340f3ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d735f78-d627-4250-aa39-229fd04e8632", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82d9df78-aff6-435b-af49-d417aef97432", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c2f940-8d8b-4655-a89c-b7e27804c946", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c87ba7-2e8a-4e09-b482-f0725da85894", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a1b2ac-fd58-4a0d-8814-f75cbf487092", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41c71c8b-b9dc-4461-92d1-e69bfbae0723", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98d6ea7b-8575-4dee-86fb-8a7db35d9540", "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": "c78bd7f5-b900-4c67-ae4b-7505b7223b80", "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": "c35c2c28-6af4-4936-81df-fc224b29c0e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff5d91d-7b88-41c6-bf80-41ce3c447111", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c7fd17-f247-4f00-a5df-5fb27ae09944", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed28517-c4f2-4d1e-8249-b228ea791495", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd2a91dd-4e0c-42a0-8845-88b0f680fb32", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d79ca10-d1f5-4e67-af9b-4555bf663536", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7403eaa-665d-4ba2-b1ec-fb63a3afe2ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca4c4321-4386-486f-a229-17cea15baeca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f9f41de-9f1a-4479-9416-d1910d3cc929", "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\": \"WHOLE_NUMBER\",\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": "948fed69-4d24-4551-b236-21a3a45ab06c", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "a81333cd-f031-4da7-9ec6-43637e4ff65d", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b4c1fc-b884-409b-8aff-79c047ce9f53", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d9a101c-2070-429c-b410-580a695869c9", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24664df-eed7-45a3-8b14-1cbc0435ed58", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da26aa4-33b3-43ef-bbdf-e8dc6448c519", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2267a8af-3264-467e-b77b-048fd35a4898", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9dbe9cb-49ec-4504-a0e3-6758082aabd7", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c570c71-a4e7-4230-a208-c1de3c5ff67d", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3751def8-659b-4557-aa44-0f9d207c8d6c", "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": "9fa5e5ea-8baa-4b74-9236-9382a1e6a2f2", "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": "8a33e5b1-1339-404f-be0a-82afbcb0058e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1cf22a1-9d0a-4d6c-ac3f-1ed69f4de8ec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bc78295-17e3-4cb0-90b6-7cacf07d93c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fdce2f5-f510-43b7-8b75-fc0dd93174b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0451b9-019c-4684-a742-6dcae5e59dfc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc058381-3384-4971-9d73-661d21450ff5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95cba2fe-97fc-4ec3-8ca1-fa8e70720488", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90efe9e1-6986-4540-9438-c990c2d72709", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11ec3e8b-4e21-4f61-a31b-38ac7cc4efec", "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": "22b1b900-eea7-4f7b-84a9-cecd972cfdc3", "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": "3c1fa73a-e4b1-4a83-b769-c149ab60e880", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74056704-5b7b-45e2-840b-9f223bcc599d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60e6af72-02d3-4ffe-8a4a-f3bf2b3a89e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbea2374-fd42-435a-b0c9-92e043048cec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768ef5de-9f60-4890-ba2d-0e4586ec6109", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df6fec5f-fb77-4e9c-b106-8160407aa259", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4574f06-18ee-490a-82cf-b5e90196df44", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610ed351-a05e-4d9e-a1c0-dafb2ef16c59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e27502d6-9c9d-43a7-ba24-113610c8a4e1", "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": "eb9a6e6a-02f5-4958-9f98-af0b4b6a75bd", "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": "1afdf1a8-d8cf-48a3-8f11-81dca07aada2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79d0186d-3bbf-40c9-8af9-846ac6c78537", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b83fa582-7702-4647-a0ee-f895156accc5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2392e36e-2ca2-4fcc-a7c6-7a1898fe16bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a23ea2-6925-412e-9ba6-fa665f06e46c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c3e0e6-3015-42f7-8620-2721def1201b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f94501-2ec6-4d86-875c-fb808fd8a796", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27730ce5-7178-4b9a-9cda-50a9169f5e02", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd39e6b7-1306-4dbc-b163-3137573f976a", "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": "1d1bb9ac-98b5-4375-b8b4-1806fef1a68f", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81d2f45-0427-45d1-bbf8-6494a844fd54", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bafb6aa0-d7b8-40f3-be4f-7e03b83db218", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e701e106-a898-4984-8b61-546e6a4eded7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5251fe84-1e42-4e3f-a3fd-6b7033559b67", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b30e87-06da-412b-91c0-49fe2545d52d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0146298-8718-4e2a-a528-00a0bef7dde1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79955e5-ad2a-430c-a0b6-84f205ec6eff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b227e56d-dcdb-4725-9c48-2906f4da0083", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e6fdee3-652b-4f0a-a60d-71a9e6f9c8b9", "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": "144a781a-3f13-4ac1-987c-51b7e92c707e", "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": "b43f8ad8-e68d-4344-9bbb-01ce3475cf5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0520de26-ceb9-429b-a82b-26765fc0d4d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36fbe07b-fc2a-42d5-b173-8b6f2640371d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "889d04ab-e3fa-4d3a-97c8-7d57fc9baf73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8179b1f7-1b39-4602-b37d-400415040e0c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb6360a-e0ca-417e-8f63-2addaffad344", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "288f6694-727d-452b-a06c-b735c60585f9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3403fc75-4ae3-4481-8fa6-0991f830bfaf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a994d44-5d3e-40b6-9a0d-7b9edf1078d3", "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": "0ae7fa72-d450-4e63-b691-11e3609b1852", "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": "3b3c22c7-93f5-47d5-b2b8-69b501add7b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea18818d-2cbe-4e25-9ce5-fa0dd6e6fd37", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8592e2c-4cb7-4edc-84e1-a892d5b9032e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f65752bb-5ec8-4a3d-ab91-2f8a544fdfcb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1576c59-5204-4773-82d9-bc59e4bec501", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8695c272-27a2-4d80-ac98-a16d262d6bf5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ec9db95-2547-4de6-8dc0-037227f5c0eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11178f66-e7f5-4121-8f1e-a279ba76b244", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "015b860e-affc-46ec-9bd5-3a74f5bf5e7e", "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": "5d4461da-6409-4878-bc6c-eb7065da803f", "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": "bb990f40-0d3b-4704-90c1-c3874e3e033d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd742525-6887-4858-a885-bd54c2a5aa00", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a99d6dc1-1a77-4a9d-87a2-d161452aa3f9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a548aec0-757d-4feb-a9b8-896810e588c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4737aeeb-f2d4-49cb-9687-87517156ccc5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d426fd9-d367-4ea9-94f3-c6ef3657e583", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda466ef-7c60-4afa-842d-d2b12589780b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab2acfc-9a2c-4090-b276-8b4d8b1d82dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e947658b-5bef-429a-b99f-757c9b51419a", "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": "07bcbb82-f3ab-4d24-a038-d30b2886a86f", "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": "05c91c3c-4945-4a8c-81b5-c51e3b67ae3e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff7db41-beca-4b56-87d6-5afc518d40ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c5db9c9-5586-49dc-bd37-39daa6c6b2a0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36bc638d-b7e5-486f-9e7b-102186d92238", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7974c33-b68c-4d49-b6ca-82d6359e659c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "014e9d77-9caa-4c68-9a5a-e82cff2b52a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96ef1e80-4f34-42f0-bc43-e6f84af22be0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7c0b01e-f5ee-4031-86f3-bf76aa26a5a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "598e82d0-d4e9-444b-a132-8b6908527396", "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": "last_updated_by", "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." }, { "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\": \"FORM_API_HOSTED\",\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": "e0622373-aee1-45e1-9cad-17e056230609", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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": "83a801b6-36fe-4ba6-be46-ffc5de213b4c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a7e6d6-e9ab-4551-8cbe-a2a17279f234", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc9b3f13-8a07-4199-9fe9-ef38ebce1b2a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b585221-e3e0-4e76-a36c-c293847c4ff3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "872aa04f-afdf-4700-a351-12a8431ba76f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1aed46d-bd04-4456-b312-fdd1611810d7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bab3a9f-6657-499d-80d2-a9d348c4f8be", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f361de-f0bc-42d4-8979-464d894882dd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "company" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7c8f78f-0801-411e-93a4-b5b75c7802f0", "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": "eba05494-c3db-4268-839e-c0b97234a7fd", "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": "f9720e79-62f2-4705-841d-56833a021640", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ee68a21-34f5-4bf3-8397-8d583efbc622", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d1cf17-274f-4b1e-807c-4e62752bbca3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cf20367-4576-43bf-ba24-615cf0e57158", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a934e386-0566-43c3-a956-047293d50f72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b3a9de-2da1-4f16-b37c-8d07057d05b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adad3c61-ce70-4df9-a630-461348ea4ec6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e3ec0fc-3c28-4157-8cf2-5c8db52c6137", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14177823-b763-4f66-974b-b8b94dbb485d", "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": "2d08e292-5e53-4b88-ac71-5604bc995909", "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": "01fb9d72-1127-4d9c-8dca-6fd36ce18328", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce4f9f1c-fcdb-4327-bd34-03c62b3fa5f7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd24040-eca6-411c-a259-46540f2f1e54", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "857ae342-a732-4896-bd26-4f7c6e5070ea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c98cc89-cf54-4013-97ef-d3b23b7689c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c47124b-d918-4834-a524-a0677483f98a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73b91ad6-e881-420d-a77e-fa580e5b70a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "937eea52-a37e-4dc4-ab40-3b6ea928ec71", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a2314ab-da6b-4f25-b46b-0715fd2aae98", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e91b03f-a535-4859-bab2-c89767433c5a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "9f54930a-047c-4ac9-944e-d844bc5e105e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888c198f-302e-4acb-83bb-3aa9b152fa37", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b33fa4-6ebd-4ab6-8ec1-fd6be10a684c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5912d3c8-af08-4adb-8960-5e86a2e1bba9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5d05efc-7c65-49a0-a18d-dd1fe85c49b8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ecad7f0-265e-4f65-82da-afbb58f7109c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c9a4872-b02a-41e3-bd48-e0bd04564f9c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150d07b9-80c7-4dee-9345-e97f4b7ae9d5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f42cae4-1b18-4aff-a63e-6ecbdd75d81e", "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": "8552b5c8-06ce-4caa-9e04-7014158f594b", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb298e69-3bf3-427b-b0dc-e499959e431e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7c6e2d7-d3ab-43a5-b399-e367b46ac01d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a8784be-07d7-4842-86ad-b221767d8446", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c722f921-c6e2-4d9e-8ef8-ccf150b03b9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4db52b7-cdd7-4c44-add7-f7f2e8ed3591", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49e9e7b6-69e8-44b3-a46a-bea8ec8f8b78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02e23c94-3f41-4f3e-809d-c6a72703a643", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc268690-9a8c-415d-923e-72dac52988e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "222bd843-86ad-4dbd-a8ae-c977444ecbcc", "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": "df782e62-e586-492b-81d8-96602d5c392a", "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": "ac95415f-f92e-421b-ad1a-eb6c5b171b61", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a730a59-712a-4208-88ce-eb49c630e63f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4afbd4d8-4dfd-49e5-9284-010f4947fc3a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "986f6d10-01ca-46e1-b9dd-e159ddcbd64d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e47d7f-9578-40fa-b5d7-3d0a2d6b5cbf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65f407f-8218-43c9-be97-906b4cc356cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b1220df-e55f-4c27-83f0-2b1456192cbb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70e947a4-ba3b-40e2-9b2c-4433e269f0b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7347438-d1f3-466d-b52b-60b7e1ead466", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd24c0c4-0ac1-4ab1-acbd-389102c03a08", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "221141ea-9de0-42a1-8a73-4ada7d0786b8", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6469d949-c583-4af9-95d0-0bc0b31d739e", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c292b1-2b88-4d90-a1b9-1e0fd9aecbbb", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beac735f-820b-4ae8-b924-a27ee3a05d22", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c49fd396-f217-4ac0-abd1-0889b56811f5", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ad4162-1c11-4ba4-89a2-72a830965b04", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43e90995-adea-4189-b22c-ac2574517351", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc12b1e-2a02-44ad-b172-34fa379eef46", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a54ce8fc-c604-463c-8623-c9470baf6b45", "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": "5e1f9f4e-e9d1-4b90-8e75-f19abe009a7e", "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": "21dea174-0b9d-4279-87a5-7333e75a029c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153584b5-dcef-4bec-8844-efe7bb21ded4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82f1181e-614e-4227-8218-59c9eb26bcb9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27571e41-deeb-4f74-bcae-eda9d6d76025", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dbe606b-96cf-46d6-b804-8a28be324cbd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2f3b87d-c277-4758-b0f1-3598ce30ef03", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ffd093a-04ab-4d50-93ef-7fd514feba40", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d26e9b29-5838-4e0f-81b7-6e832da1d389", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83e1ecb9-ccfa-4987-a6ef-f3815caf1131", "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": "a465f765-4f15-4a67-8027-6f90d512765a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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": "1dbd0dda-fb2b-40c3-85b2-9e16db09b5c7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610dbcd8-5e01-4c3b-b1ff-2f2cfaeba1d5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb6726d-7469-49ee-bce5-851da42198dc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06298a56-3c60-4ce8-846e-f4c3075f1c09", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "587c35bd-a552-4769-be6b-4d55f87ecf05", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdca039e-b8f7-49f5-b937-be85fda31cf4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57d7dfe9-6eed-4de1-bb56-1c395d8a3e70", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "344e0100-5a58-4fd7-a3cf-9a5635fddeb9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d51448c-39e4-4873-b181-d5e23f3233f8", "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": "d5fb0607-aa43-42ea-93d8-689284f3a351", "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": "93d784ef-0127-4848-9509-8739feeafa36", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5eb9c0d-63c4-4bd1-b9a8-9ec0973c7721", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04f048a7-83ff-418b-9251-4c1d39cbb379", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2303102-d9aa-48c9-9694-fc70ed041563", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b6a1a9-54d5-4a50-b088-2dd8e9f134b1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f7a468-ab5b-45bb-ac18-e423c910f79b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ff5797b-5a17-4590-b589-ecc80634a915", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "355f1855-81be-4ada-b2c6-9abda46f025b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be868ec5-a0ab-4a34-95d9-65151cd93d97", "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": "5b65818c-8a5f-4f64-bf47-f7560d381c8c", "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": "1384401c-314c-48c2-a4ec-578b85fa0a24", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd0a302-c626-44b2-b529-9e357260216c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85fed0b-9192-4685-864b-03b955e24f50", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f949e81-395d-4096-80db-cd68dfd5f255", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c83aab3-e460-47f5-a39e-b38cefd9b88c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09bee6f7-b94c-4ae1-aef4-943bdff362f9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27a2d0a9-2829-416c-8ab0-4b0ed9e359d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6786273-f030-44dc-8ed9-035253467b21", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aeba7b5-92d1-4509-9789-c2067903d5e6", "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": "6f45dbe7-ada3-4d6e-a323-d23b86ab3e86", "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": "3ddb3be8-3680-4339-88d1-d67a3e2b56e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff2fda5d-1f0f-493d-bcee-a71cbf8a4cf0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a23752a-5cc7-4ff6-af56-f37046ef0f18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5657a821-3966-49f3-b452-3218b62b45c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66cb7242-bc5d-489b-a94d-94e25f6014ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfd61c28-1370-402f-a3dc-ecf6b5e4389c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fde6348d-4972-43b7-a961-387daa35e96f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88741e21-c1d6-447b-a491-c2cd5a9280f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34d6cf3c-53d4-4c23-a909-ad51fab6ca42", "name": "List Contact's Tags", "request": { "name": "List Contact's Tags", "description": { "content": "Bulk-retrieves tag-contact associations across multiple contacts in a single request. Use the `-` wildcard in place of a single contact id and pass the contact IDs in the `filter`.\n\nReturns lightweight association tuples (`contact_id`, `tag_id`, `applied_at`) — not full contact or tag entities. Results are cursor-paginated via `page_token`.\n\n**Filters** (`filter=key==value`, semicolon-separated; `contact_ids` is required):\n- `contact_ids` — **required**; comma-separated contact IDs, max 100 (e.g. `contact_ids==1,2,3`)\n- `since_applied_time` — optional; ISO-8601 datetime; associations applied at/after this time\n- `until_applied_time` — optional; ISO-8601 datetime; associations applied at/before this time\n\nResults are scoped to the contacts the caller is permitted to see. Example: `GET /rest/v2/contacts/-/tags?filter=contact_ids==1,2,3;since_applied_time==2024-06-01T00:00:00Z`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", "-", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply (at least one is required). Allowed fields:\n- (List[String]) `contact_ids` (max 100)\n- (ISO-8601) `since_applied_time`\n- (ISO-8601) `until_applied_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- `applied_time`\n\nOne of the following directions:\n- `asc`\n- `desc`\n\nField and direction are space-separated, e.g. `applied_time 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": "0beb2b69-8f9e-4bb0-b921-77d89ff49001", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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": "b21b4f83-43b0-46e6-9b8f-8d6f8b0d0327", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f9daadc-dc92-40ca-9f8c-434a4c2bb9ec", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eebf3c0-b971-4a97-ba95-86189447fa1d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce51721d-56c2-4ff2-aa0e-b6845e2bc50f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c26227e2-5e55-48c8-83f4-8adbd4192d62", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c968cea-f577-4ecc-bda2-c6d28330c59f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c49620-1f75-4dce-b8fb-775d93bab92d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb77d02f-fac3-4f32-a07f-d3f88f1e0eca", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "-", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52886469-bcb2-4a72-99c2-cd69a6700870", "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": "20d4d112-3c90-4ec0-ad96-fc70ed1feb94", "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": "ca3de62e-39d9-496f-bdea-3948cb925396", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb42f57-1f13-4bd1-a95d-da3b1ae8af88", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde1d4ea-8516-40d6-ae58-59c6d23153fe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93b174f2-1edf-44cf-b3be-c49217589fbc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f324a253-7d88-463b-be5a-91d8b576e661", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e0f6401-620a-41a3-8c62-57a612ad29a7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a29826b2-8671-4ebb-ba1c-c5d85fba30c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a453f8a-d572-4276-bfaf-249b1c1b87ad", "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\": 7566,\n \"message\": \"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": "d59a9181-457a-4b7c-a12e-b614ddf71446", "name": "Email", "description": { "content": "Email endpoints.", "type": "text/plain" }, "item": [ { "id": "1e9c11df-78f9-4000-9b1b-1c13eb919bdf", "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": "ea189b33-25fe-4062-a93f-102d6d6caaa2", "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": "bc72ccb6-1228-4a73-8b4b-97a41fa6f87b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58769ddd-cb06-42e1-b966-f332b1c3a298", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96152990-3b60-4d3e-a37c-cdceea9b6cd2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e66d8b4e-217c-4e33-a7bb-d8e9d74bf21b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb1a34b-12cc-47f1-b618-26c98133ce38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6fdac3e-e783-41c8-957d-b14301c188d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a16a2563-809b-493f-8d3f-ddbadc6b99f8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80a68867-1b58-4f11-a531-d75a6f2fa69e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67bbab59-2723-4fe3-91d8-aa62ed47c550", "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": "a8b8697a-11d0-4242-bc6b-2fe42bc8d479", "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": "fb61a5ed-c70d-4274-9768-78a20daf5689", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37dd50f3-2e4d-4ef1-a12d-5a884e7606de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "401ba3ba-083d-4b90-854e-f09a59209001", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1844bb05-3748-4a8d-9ab8-d0d778adb744", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06e6168b-3576-413b-afe9-e6b682ad02ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfd3897b-5881-49af-bc75-e4802c6d32aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf78ad4-64c5-4c2e-8a2d-66f3b76d5789", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde374f4-4085-4c47-8607-ea5019907e4d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3480521-65d9-4c17-9db9-17422442ca95", "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": "2d50ac84-cea3-429a-89ff-982642cf622e", "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": "f567949b-4747-48bf-94ba-d5592df324b3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e082781f-8acb-481d-b362-cdb1118310bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8251b54-d0a5-4b23-97bb-a32faf65c8d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9b63c5a-eac8-47d9-a6d1-4e594786f904", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58f8431-33bd-47a5-bec5-7652b1eadea5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5538d6ba-f061-4dda-8697-16f73ba81650", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58a06515-6e0a-4f6a-a6fd-7ffcb5da9456", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c74ea83-d560-429e-a2e7-b6eab7509193", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c73599fe-ac2c-4f82-96a6-3cf6d9243e0b", "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": "5cd9c98c-3342-4c77-b514-206938f3986a", "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 \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e77770f-e82f-44dd-bc20-35d5b18d6ad0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5887940f-d983-4060-86ee-8f30484074bd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa99736a-cc6f-4625-81e4-dcd69b55c5e2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4db7519-4428-44c9-824e-eddafb8123dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91a20f10-96de-4887-973c-24e973a9ddb7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db8e1297-e5dc-4dc4-b915-77179211357a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d566ef2-de23-4796-8131-b27682ea6a51", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6f0fc0a-235b-4d3d-a972-9bb8b13d4b4a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1a164d7-c8f7-41f0-8bd3-23596fda1fa2", "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": "167f3a80-80a3-4fe0-8997-f4f8b8722426", "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": "0f32bf00-a670-4049-bf7e-1680bb528d14", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f15f4982-9f21-4e5f-8bda-c6067d690037", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1738ba27-cc37-444c-b505-b04b0dd1e1c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50f4a7db-0b70-44d7-bf1c-b1e3f2704317", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0acf2bde-f879-414e-a509-da0d9fe15235", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b37e69-357f-4ccd-a012-5fa9c77702f3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f26a93-1ca3-4595-b4e2-0b7146c5a168", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8426b98-8a15-4f43-a209-ee7581c4d5fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b180c378-e1f2-4887-a401-adb688272a60", "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": "3990befe-ac04-43db-985c-cbf36046dda1", "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": "5bfd6c85-8da8-46c4-958e-1af5fb14a89d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6527a206-7a18-4351-8ce0-05b16cebf0ea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba8934fb-5367-4a5d-ab4c-1fc719930381", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3188e3-9755-41d3-9b50-0719e7389e2d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a043d4c-f969-46a6-b450-2c51dcb255e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c44446-a2a6-4d7e-a748-43d06554b319", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4730b484-dfdf-4c11-8250-e640a2e26f47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e411648-7662-4b2d-9025-2bca85e9efd8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4601f01-ea6b-48c3-b0da-93765bd641a8", "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": "6d3a7ede-3267-43ff-a7fc-645bd63be9d0", "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": "50e6f898-f65d-4ac4-ace5-a9a113b11870", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b2cf845-e048-4709-a9ad-bbc0404c8b0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56de75b0-b5f2-4c78-abd4-6ff77420825c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b876c2-62fe-45e9-aa23-cb6bb4f8b502", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "054bff1a-0f5d-4719-b59d-3dde8b65ebcc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bda4245d-af1a-416a-933b-5323ab5a1eb1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b66624b-3f63-4474-b927-4319a6adfff2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca62942c-1e56-426c-80f1-f7e636101f59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e042eb6d-da61-4545-b6c2-3b61cb80c1ad", "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": "b52956a3-d448-4409-9aaf-0899f05a243b", "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": "8d2a61a9-feb9-45e4-ba1b-67cca6f5d20f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c43101a7-2c70-4e77-85a6-f5bdef5c1458", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80494895-65f9-4b8d-8e2e-36c4045e34c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "428e723b-b6fd-448b-9bbb-339b0b59f3c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9222774-8e25-44ad-a6af-c1439df4186c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6875e834-4a13-4f58-8d8f-04b8d2d8f7cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aefb8faa-bb07-4246-af93-b24239d19880", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdf384b-5c77-4c91-8966-ae877bd1df6b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26984d13-cc78-405c-94ae-219e899e57d6", "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": "cbebe950-3032-445f-afeb-6cb92b95a8d2", "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": "4bcd3cd9-62dd-4a11-b6ea-ec06818bc482", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25cffba9-fc1c-4b91-a5f0-211141da0714", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50fd5451-2851-4837-98b1-e836e59f39db", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5830c06e-5e5e-4f85-b63d-87cab0894c1f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb0b3067-0348-46ff-9a7e-aa4531770670", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "445a53bd-068c-407d-95a5-d474763368b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1568aaa4-11fb-4d49-bf7b-e03f7524cac5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b51dbd58-72a2-49fe-a16a-64f800114726", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0382201a-c95d-4093-869c-0626790fac49", "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": "b4aefe06-184d-40d9-9534-f468f5c2e08e", "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\": 7003,\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": "2db3c75a-882b-4ef6-b43c-7f38c9bcd425", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dd5ffb6-9e7c-4de8-aa27-8f3fa80ecf0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7235f82d-6000-4613-99a3-7f09a041471e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b2a3603-4491-4648-a4ea-28868e00580a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85bb67a5-58f3-41a6-8aeb-df03cd8b3b48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f760307-ddbd-4560-ad51-930becf2e532", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37d47257-6421-4f42-bef7-edbae3d39574", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51fa1f38-0918-47e9-a90f-46bde5c5808e", "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\": 7566,\n \"message\": \"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": "5a48d241-bfd3-4a67-8808-27e60d15cc1b", "name": "Email Address", "description": { "content": "Email Address endpoints.", "type": "text/plain" }, "item": [ { "id": "ae7bd0fd-fd0c-4877-9c49-de209bf5faf3", "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": "0821911f-b62c-44cf-a0a3-6048ea627c7d", "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": "0915e2fd-6674-4e8c-8217-bc3091184750", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e74cbf-e77c-4626-9a10-37e128d9d073", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d41dd838-4f7f-428f-bebc-fa5027346628", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d43c11-71c1-4dc1-9a84-0206282122e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03919ef8-be20-424b-9735-b5786bb158f3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "214efb1e-e026-49a2-9608-5381529d2eca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba53f64e-1650-4e5c-abfd-690e2b74ec3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "863c23dc-79ab-44f3-8779-ff8a8cb62fba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "846a3dca-2ee8-47e8-9435-50ad620b9b07", "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": "2ed28c90-51f9-4bfe-8adf-790ff51f07ba", "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": "51f0263e-a983-45c3-a373-7f99f82713f7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33f6a03-ef68-43a9-8576-a7f2e9bdf3d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6745ac53-f410-435e-80bd-fe2d2e1a7ff0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac491f54-88d6-4671-92ac-a6bb560fc2fb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcfe7355-89ff-4e20-92db-fc594f87e6d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3344d0d-1e19-45a5-810a-01bf462c6a5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d39f86-0a51-4927-bc64-71fb8bba6c3a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "067ad224-62f3-4e57-9827-6ffb8357e57f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "589bbc2c-c60b-46b2-8f1f-87fa7f6523b3", "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": "e537aadd-0f6f-42cf-8914-f3d063d34b17", "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": "f177c287-b460-42d8-8b44-822b0d5788ac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d409706-896e-4e80-84af-de355676a7d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "923e4559-7268-497a-af87-e8b9aaf7fe6f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13b8f079-13da-47d3-8c5b-763c57ea5f12", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e3bc31-44bf-47b6-b15c-ecf078e2f8bd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf8d75b-0a16-4e4b-873a-57721929e5ce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed6b31e-3a4c-411a-bff4-320d97ae8939", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eee8ff7-fba9-48d3-b5f1-1befff2e494e", "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\": 7566,\n \"message\": \"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": "6384d0af-4ff4-47f3-a13b-2d1f86fdec71", "name": "Files", "description": { "content": "Files endpoints.", "type": "text/plain" }, "item": [ { "id": "95b42139-2d91-4f08-aedf-d4983cc6bd66", "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": "2d91121e-874f-4675-bf63-c37935ed04bf", "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": "1aab0684-b7e2-43d2-9f9a-3effa1301358", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249bae16-e60f-4680-a0a6-29bca13a26f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9044f4a9-6ba7-44a9-b57c-c85c2bce6c8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4121a2e-e543-4d6c-a6d7-44ee0b2d7cec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "319bb569-eb0a-4e22-b866-7182da6bd044", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "528caded-e169-46bb-899c-e41f921d4148", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a85474f-3ee7-4656-9641-de3afd0f3df0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed73f290-1445-4f3c-96de-ac168abde7e8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a22fe2c-57ab-46a3-9604-3f03ca06e709", "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": "2cea1bb6-ed59-4122-8c3f-90824d1f88b3", "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": "3e8f6197-869e-4a95-8afe-df722b89e863", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edea8cc7-25ec-44b1-a2b5-2be8d38ed5a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622e899b-e81c-4e89-986d-7dd358ca7c4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08548ffc-5252-499e-a6d7-0f4a690d4b81", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "261602fb-4a43-4848-adce-9f93a1677f1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d06bfb77-cd02-4705-a8a5-668f3504e376", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6324a0ec-8fda-47d2-b04b-696c616e0a3a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a474785f-4682-433f-a3c2-e553a35ab475", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b387fc0-df51-4cb5-b165-e9dc94bfcc03", "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": "be0a6be7-7162-47d3-b8a0-06d323380cda", "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": "130ed9f9-388c-4308-ac3b-b9c5734980e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fc930f4-df91-4db2-ba80-62996aa1e1f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9229c01-2296-4659-a2dc-573608af1242", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59e0dce9-9a4b-4803-b5e8-ae74e287a743", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dd537ef-d013-4364-90fa-b2ac62dbef5a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d716cb2-8919-4e91-97bf-59acdc3b5f58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e860b6ca-0a9c-41e0-a7b1-8c9c5b2ca80f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b0d396a-a174-42ad-a1f6-bd411f7e0704", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fcb136d-d25b-4dae-8422-f27f3052575a", "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_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": "file", "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": "6baddc4f-62fd-4a18-aa33-553d6beec52c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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": "afef7330-a44c-43b0-b7e4-39829014aaff", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3635304b-bdf7-4360-a895-60747e0349c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb5957bb-f914-4ba9-9592-54bd8bcf9f24", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29bb688c-4a70-438b-aae4-0286f74612af", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d660472-844a-4707-8000-9aa00a6f92dc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1883688-f06b-4c49-adb8-f8f83ea64207", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e944880d-d42f-4c06-a7b7-f16fb6eff535", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44782ec0-776b-41a3-a44b-40dac9de76d0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file" }, { "key": "update_mask", "value": "file_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d509f052-1807-46c2-b6f2-1f45e0e50fc9", "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": "51633980-2105-4a5d-a079-dda187635806", "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": "a948742f-b504-40c8-846b-55ff8bf392c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c8355c-c0b2-419a-8015-4b46da4e0da6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8076860d-ee50-406a-a415-1f9df886b9c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddee32f7-4ae3-4dab-833d-61dee9f165b0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d91912a2-aa9a-4c1a-897e-7c51d34be2d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abcc95e6-0720-4deb-b14b-a06065249310", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "606f2390-1df5-4553-9dfd-6a8febd04998", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4b2b01-401c-4cb3-a511-76ffa6b463d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba8fe2ae-38d4-48c1-b19a-3f0b9e46596a", "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": "45843858-2c2d-4008-a0db-9bdb5d77c914", "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": "d183ddfe-5340-4f36-a697-11e7f86cd009", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f9ea5a5-e343-4b0b-ba19-b73bae4a9c9d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7a5e1c-aa7b-494a-af76-8ccbe8e09b5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd6da83-d8b8-4f6c-aff2-780d991d7a47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acaa930d-d2f3-4168-9769-c6ee8d7477be", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69b63254-6805-4fd3-97e6-0ac9efdf1f2b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b3a39e5-392a-4178-83ee-c9141482f338", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6445d7e3-acbc-429d-b281-82e8ed712c60", "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\": 7566,\n \"message\": \"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": "54639b03-6cff-4952-8e86-c9855557ea38", "name": "Free Trial Discounts", "description": { "content": "Free Trial Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "fcf48028-58da-4ce4-8636-6d477cc44c0f", "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": "fff5e0be-2da4-4d1d-af1e-a7f2bf11aefa", "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": "9dfb6903-898c-46e9-a9e5-2d5784a5a5ee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cacdbc6f-dafc-4789-a98d-c59534ce9a92", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b88fd9-489a-48e2-9eec-53b1ad960b09", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37caf17b-1256-4053-8289-befc338d25f8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767b5bfb-a922-47ea-a197-d615fb5aefdf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a25a291-01eb-4af3-9610-020ad4abf74e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "796dcfb8-6dbe-4df0-919f-15ed469dd52c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01b82f28-b554-44fb-9ca5-4b6436e1bac3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c57266e5-6466-44fe-a3f6-9af2724e7dce", "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": "42ddeef8-0430-4470-96d4-c9aa18ea815c", "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": "29d68cc2-d0fd-44a2-8187-f8043c3ed8f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fa4f146-b866-44e4-8f56-e2214733fd1e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5adcaaa6-7f42-43c9-8e63-a8f05a2522c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716dcdaf-fadf-493f-973f-4763a701739c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e52b9b28-2bab-4c36-b580-5194b0733f31", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f88eaa97-26e7-4d8a-b6b6-f0e411b68f4e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952457ce-16f3-4842-85c2-8de368b5de1e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9249645e-03f7-4ee9-9d1d-6c2531318539", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d4828a9-2cd4-4bc3-a4a4-ac591d7e3a04", "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": "dd9129d5-a680-4cb8-b99e-979b6dd5c049", "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": "cbd59175-7b10-4f83-81ff-e07bbb54a451", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c6637f-0344-4865-b3ff-138fdd58c537", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "239d2e49-4af4-42dc-b720-845181e1fbe1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df5c6574-9296-4fb7-aa0c-5c407c0b13dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9418843-6265-48f2-9f8a-60c72226b41c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2937f4dd-7d4b-4c64-b13b-fe8954013b97", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fcf9849-6e53-4ded-b198-52279f9ad777", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5aca069-ce86-473e-b08b-3125f6f36393", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ad1309a-86c4-4641-b40e-c9e832b8e97c", "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": "2af682bb-7b1a-4396-8710-0d0c5d1207f3", "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": "e111c171-6d4a-4162-abc6-6e4e56b240b1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a281bb91-bfb5-44fa-a53c-aaaecbbaefa1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dfdf3a8-56f3-408a-a0a4-baacbcb7516d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "910db7a5-4fd1-4c3b-baac-dad64a1d5b1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a55f314c-0f8d-442f-a530-426dbb81d78a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae385688-24f4-48bf-a09a-404f15882f7e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f8e810-6835-4e75-a473-6cf947b97f4e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60a697c5-9408-45c7-b95d-8e561606a2bd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25bbad66-b728-464c-902e-b8e4a198d8c6", "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": "1b797554-2085-4172-8fe7-d32f09597240", "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": "f5348fb8-b459-4159-a1b2-cd126bece548", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ba81d9b-303f-4862-b4b7-6d4f5c5cdfe5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb5e9b26-2e4d-47ff-9766-d2313c49fd3c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ac0b5e-e24d-41d2-8a90-19f6c850a197", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d19a3e4-d2ec-48c5-a0cc-bb7fc540eb96", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a826a87-529d-451d-aa3a-b1564dfd0fab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b39bca2d-5c9b-4e30-87ee-71c69791db5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bc1f5f5-4c76-4fd1-a6f4-495dada2f318", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4871872-94a0-4000-bd1f-41f96075cb03", "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": "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": "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\": \"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": "dd11be93-d990-4c76-b86e-f245c490b7d1", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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": "22b17ea2-7949-4d49-a9ea-9428106531c8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44229c56-a9e3-4d95-837e-1e140e48f59e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3069b6-839c-4e4d-96a3-dc6a45deb981", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "151a11e0-f3b0-4a1f-adec-4980805b6dc8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51864a8c-96a9-4e45-823e-34693e4ebbc0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cdd349d-226f-456c-ac35-a021e444da3b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b9a70cd-bf2e-4d95-9670-9b8abd5328c3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b636b2-073f-4f49-b4eb-19b9dc7cc591", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "free_trial_days" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bce45043-70ec-4d72-a242-b1aa97c6f804", "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": "e7e856dd-cee2-4117-ae99-3ac7fa12ee1b", "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": "c11ad14e-9ff3-48c4-bcda-3543a15bacde", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73221b67-fa7a-40e8-9357-e824d3f6837b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e612aaca-7686-44ed-a9f1-cd2c346eb29e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b7ff6d-0db9-4f7a-a25a-9c7ca2638616", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255a10f5-f11b-430e-b975-582ce880ee53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ef42a14-47f6-42ac-bf13-03688f430530", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "307062c3-81b8-4c21-a448-05bf4db8927f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0982408f-8c12-477c-8b3d-b67bcf4ea215", "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\": 7566,\n \"message\": \"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": "7467bdef-22d4-4128-abec-7cc7841ee74e", "name": "Integrations", "description": { "content": "Integrations endpoints.", "type": "text/plain" }, "item": [ { "id": "3ba5944f-d291-42d8-8685-0ef2442112bf", "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": "a8506cd1-5b30-4cea-82cf-615586ab1f86", "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": "bb29a234-33f6-4f5d-85c4-6e2082b4d8a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1327e1d-d3aa-4cb4-89b1-ec93ffdd0bea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f00c0984-6f31-404a-afb6-0607bf1a1ea0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "889ef7e9-468f-4f95-8768-1f5f3e280aad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a748baf7-92d8-4048-b293-1b861e18b185", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7044bd5-c089-45d3-87ca-52d397cd3746", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6cca7a6-ae95-4d31-8ff1-3ff1e75574ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a55fcb18-5f0e-4b06-a5f1-c6847aa8f7dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f940d208-3c38-4096-903b-beca635f19c5", "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": "9f013e62-a3cb-4bad-8625-e3157dcc4ac6", "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": "592f85ee-b7d9-4fa9-9f91-2cd3aa631c5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc4060d-8e37-45da-a1d4-272462c9e1e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30fb28c6-9ce7-4fc6-88c4-c70df2d0da22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fab6b1e-7267-4f7f-abe9-02e304a14097", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81882b44-4f50-4b4e-b22e-a652db3a6ed2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f468fc0-d314-4164-a0b3-681f38e12af0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54042831-08cb-4d15-9136-c7dea4fb720c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a78e83ab-80aa-4da9-9b7c-a1bb8d1d71d2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd03ba8b-24af-4498-a602-36a4825d4603", "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": "00a319a2-4175-46f5-b2d8-cfad21bc8265", "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": "bbb69636-2cde-4703-8368-9b2a4ad9d187", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d06d06-171c-41d1-93be-9fe8ff778f0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d9732a-f3a2-4efa-ac16-e2a2a79e1846", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de397c33-e606-4e73-83a9-d28a9cb25a6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7933fbe9-89e1-4fa1-9842-4fe1bd38bd71", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d710854b-8721-49bb-b811-9151918b0ef3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70e3efa4-00e6-4206-8683-8b2792079af7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a2d415a-f823-4caa-aa2d-a9fb2b61ec74", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67d7ff82-549f-4cfb-b9af-9d79529d2fb9", "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": "6e8f3eab-2197-4d90-b22a-d1c276f3fe3b", "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": "2a866593-ae1c-49f4-aebf-7f24b948c247", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aef6bcb-9052-4497-a9ef-d0d2e54cced5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ac770ec-863c-45eb-985d-a31e6d065b89", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4e886ad-7ce7-4bd9-81fe-8ab30d5e8df7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c28a9372-11dd-4c8f-841d-5344c32f0067", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99a9a151-c60a-4f81-91a7-f32a7ff41b4a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "348e4388-3ad8-4d54-a192-35d74d5e829c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2111a223-5cce-4407-a343-d87d4a8f09f5", "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\": 7566,\n \"message\": \"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": "f362e63e-6420-4344-85a4-701976f0fd42", "name": "Lead Source Categories", "description": { "content": "Lead Source Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "7ea158ff-344f-4a32-b82d-6050ee8b6d86", "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": "f8021f6d-a8c9-4677-89ed-f4f1db29f4f1", "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": "e5da9150-b01d-4258-8605-30015bf56617", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d09745-0f92-457b-9c69-3169347de811", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a0cef24-cf4d-4962-9f38-949b760d1cbd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a116394e-0d55-4154-938c-19580474c3a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b5bad59-4321-4010-a9ec-94f15f5f1fab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "000817c3-6f2f-48e7-b240-b7323383c15c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dadb982-d8d4-4a70-a4fc-0bdf5f17f2dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9bf4091-cb4f-493e-9423-d5b50162795b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f067e23-7174-44d2-b553-6bf3d4677689", "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": "3cc7d83e-0d3e-448d-9923-4ce139cc5099", "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": "0a7957ad-140b-42a8-9544-c09cdc43c146", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e961d313-1ea1-40c0-bd67-e616ecc8d031", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df10eb47-f851-40a7-a02a-f76857c90a1a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b94bb718-49b6-48d9-9527-f4f23af244a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "250c11be-98c6-458e-9cb6-72f1079c4ef6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97041937-39d8-4568-9310-4b1ef60ffb48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31903bd5-9345-4c58-b675-158f55015d1a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0482907-6b4d-4acd-907e-598c5db4f45d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6b7cc76-3ca5-41da-b554-4d9f43c6db62", "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": "7f7521a4-df95-4f4c-b534-3c186a8314ae", "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": "283c5ca4-b033-476c-a2c3-48d540e611bb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "065dc0db-15ef-4701-8a34-ee9ffe10cb90", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b74324-4da7-4cc7-92f7-d7043ef8f4f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6895075b-a171-4935-84c7-9dbdae607fb8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe5cc0e-4dbf-4efe-8ffa-b64ee0821237", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "662a6d59-8c01-4459-b9fe-052630127028", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443e2a54-a38f-445e-8ece-75c0a3e225a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d480d9-b2a2-4f5a-821c-d4950329ff87", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efee3116-a6e7-4e79-aee2-9cd34f66fb46", "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": "ba158c79-c351-43ef-a0fa-998c5d560e9f", "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": "e83b26d9-92b7-43a2-abc5-f430500d0059", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a0e6c94-3f57-4b31-8d67-8ab2a4a9533e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0729b21-3935-4352-b246-0dc666c13ef2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d06ae474-0ac0-4641-b6ae-d5046742737e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e707c0-4aa6-45b0-9a7c-c10500e3e2eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9199917f-9af8-4a8a-b50f-9bd0cdffde16", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b43f812-a5df-41ee-bd2f-03a88c4a73b1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feaaa2d4-9694-41d9-b928-bbd4e3c203e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36265b83-71bd-4d41-9d12-d052a5f5b283", "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": "5ff53e55-7a99-43c0-977a-bae6f6cebb55", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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": "7121a2f0-1e1a-4fd7-b564-a20f979e4f2d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a175199f-d812-4f97-9239-4c1abaae8c12", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e585c37-ca23-434d-9565-3e645f103763", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d06f34-f594-494a-bbdc-1e2059d8d385", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5318e55-f831-4921-b038-4e17e7584611", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "587a4f30-c091-498a-8366-e4caf1fa0e72", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "771129db-2311-4b34-ab99-65e413d45f6d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "903f6678-38ad-4d3f-9421-b502fc378a5e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"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": "f5124b3c-b181-4390-b359-f6b1b1094fea", "name": "Lead Source Expenses", "description": { "content": "Lead Source Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "cf6b1106-06ed-4de0-b926-10f31ab690de", "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": "da72a26e-ef37-4e85-933d-6b3f430d7340", "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": "0f31d655-35f6-4f08-bde5-88ef534980cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab7af9cc-ede8-43ef-942d-c218decac93d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53b8741-d1b0-4797-a447-4a22049c51b8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9521716e-0d39-4a79-af6c-02948f0c14e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db92a149-ec28-497a-9bcb-6ee026692651", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12f4df4a-fe97-41f4-82e5-08515f19d85d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "168a934b-f0ce-4243-9204-b77b94d7def3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15de3172-3667-402d-bce0-c4ccff9aeb6c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3ffff0f-11a9-473e-9c24-55acd58ae9c1", "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": "685aadaf-0b7a-462f-8fc3-d1aac45aa5e7", "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": "1e40fbd6-f648-47df-b61c-20948d969920", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b228589f-d542-4909-bec0-1432487981c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6f0934-2baa-403d-8638-58d311ea4b44", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24d427af-a2b8-400f-90cb-74910ecb223a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "092717b9-a831-4baa-9b61-58e43b525c86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "557bc155-e583-439a-8400-dc547e49483a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b10e54e-5542-4ea5-8fda-95cfb6bafeaf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c270d9e0-cd9d-4f02-9f26-a90184207109", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ce43204-f48f-47ea-a60d-e9d21e0597be", "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": "835cf41f-c71a-4231-8afd-fbc4a386daf3", "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": "9e0c3574-cf6c-45ce-b649-0051e7f7db17", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc8be13-7523-4c73-82a9-4fe13b6a65d9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af448ca0-8d26-40eb-ac56-7c4540357c6f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41b6e0ab-c701-45a1-9220-089aef0d9240", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c8473b8-5898-405f-b8e4-416462f50d0e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4de8b582-4833-49fb-a17b-64e600c830d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a57bb999-530c-44d8-b8c0-cf22b08cca69", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b91c1115-eff4-4b08-9843-65933a06f257", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ffb4dde-4de6-4817-b712-f171d3d7304b", "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": "e51b2b69-2484-4560-b19b-14355f466905", "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": "e48b1a26-87e0-41e0-9b75-b0f07f80b75b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d526fc-2525-45c2-aea4-b9efae8921f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce08769a-ade0-4cbc-a93e-a31b82af7b0c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0402f6c-b52a-403a-9d1c-c8a92c669ac7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db9bb93-6f2d-4017-9817-24ca6882c127", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eccfd46f-fbe9-4b0a-a00a-33ca6826eac2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2429663-fa84-4f4d-9abe-3e839a5f9b4b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1328b38c-e596-427a-b184-c4f38faee4c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d20b562e-ceca-4703-a23e-ddc37023b4ca", "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": "185759fd-8256-419b-b453-c599d49b970c", "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": "1a6301bb-1cfb-452e-aeed-c6105d9d77f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcb56f96-2502-45a1-b17b-2ae6fc573c28", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe587be-1ca4-4bc0-a47a-ade7f3279917", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "997dd243-4288-45e7-bdb2-627e751fddee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d846c4-ce5c-4d4c-853a-2c04b04dc2a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a74ed98a-d936-4add-908f-b73abec0db14", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6703599e-18bc-43dd-b626-d7fe820d1c5f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbfb375b-3954-408a-a35b-03840e89d0f3", "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\": 7566,\n \"message\": \"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": "370c95ca-6257-45e5-ab97-b9ef33c3933f", "name": "Lead Source Recurring Expenses", "description": { "content": "Lead Source Recurring Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "cfe66ce5-a6ea-481e-95f5-1f60fb6562ff", "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": "2a431f93-b420-495b-bf81-04d55de1e4bf", "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": "46bdbdf6-ffb3-4e1c-b5a8-10cef73883ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea798b77-3f48-41ba-9f0b-cb0cb6dba4c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d52013ae-eb3e-4fc6-b82b-542cda35e1a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5422e464-8953-499a-995c-cf405979a6d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd6711a-f435-4430-a162-1b934dee359e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db06c78-d765-423f-b8be-47800a49f484", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eb693e9-8933-4387-84e9-eab813af76df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4324054e-65b0-485e-843a-cffe11174860", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08340d06-b50e-4dc2-b135-ef2fd0e99b0d", "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": "1f128dab-08b8-4a96-800f-82e250ce671d", "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": "9995a592-b64b-4d35-87a9-a851a2440fd7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ca19181-c9b6-4a7b-b48b-1daf7a6ecae6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57484a26-65ea-4465-ad27-b538cc2e9528", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bbe22d1-e4d7-4c58-acad-3f614428d19d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ecd3ad8-910d-4a69-8bab-2cedbf947bc1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc44fb33-4ea6-4d86-b927-a91a5f7611cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "377b5411-f49f-4a2b-a767-5e68ff1b501b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ee9c3ec-05ac-4011-a8d3-9439af892521", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28f85996-b55f-406e-8a8b-e6d88133d644", "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": "d27d3df4-5170-4b7d-b032-52b12982baa6", "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": "3bc41df8-c9ed-4755-ab1a-fc42e8b0a58d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c21e2a-f3e6-4765-9488-5ab144e6ecb9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbb72f1c-3666-4596-8f4d-0680a3fbe5f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10940ab2-139a-4a19-aebf-572b0e2ed641", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abf06cfa-056e-48d1-8745-04d28a9393a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9cd237a-affd-4d15-aa01-8da9d14ac510", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c2a0b46-2a31-4bb9-91c9-224d1b51c1c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edfdbdff-0adf-48d6-a0b9-41cc69374cad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e364940-57f6-4d51-a527-f5ffa717774d", "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": "3c29068e-725a-434c-ab24-8a27d49b4fc7", "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": "cd5df59d-23a4-4a6c-8618-e21eddf92b2d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45b04cd1-5b5e-4f47-a71c-66c607d20050", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36551e5c-02f6-407a-8569-c566e869943e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6b00397-0df2-4086-83b5-12f0b92a7773", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba6faa1d-dce4-4b67-80b2-85ecbe8b852b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be203156-f7d6-4dc0-9f75-229415ad6069", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40f33e88-5c34-4f9d-8da3-0fc226db4518", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "810f10e8-8abb-4310-9ab1-4bccd30f959a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a178c22e-fd9d-4884-b73c-182bf70df8ff", "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": "title", "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": "notes", "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": "879db997-0bb4-480d-a960-e38d435046d6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "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": "5d5e333d-277b-43d5-a866-71796d3ee93c", "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": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01974c23-5614-46a4-aa94-8cdc5226208f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6613228a-56dd-485a-8101-ea228beed772", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d7e8a7-11d8-43af-9313-91e55ebcf2ad", "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": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "109663b1-9cde-4c4a-b75d-05c0851f2d51", "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": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3418ee96-b56a-4211-b4ee-7a5990388681", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ed6d700-58e1-4395-91a4-c13261336040", "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": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f4cc120-4e38-4d11-ac51-2b46d82687c8", "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": "end_time" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c65e0b42-f890-4665-b2e9-58795306c135", "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": "dfe089d5-6167-44fa-9989-368aa4f1c592", "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": "9bd54bba-ac2f-485c-8282-29fb86286bd2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e232638-c33c-436b-b6ae-6e63898988fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a5f4a02-5fd6-472f-8105-9a7e5e7e6310", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79886612-3749-401f-bcba-c48842a22e72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84dbcd64-d0f0-4fcf-b8ce-e4a6fd70a207", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc9f144-52c5-4613-a7c1-9acdc35dfd61", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "188d14b8-178c-4cca-8aa9-c222dd412258", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c4089d-d0c8-4cf1-b465-8a7c33de9947", "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\": 7566,\n \"message\": \"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": "94ac6007-f53d-4ffd-8227-64c4b13e22f5", "name": "Lead Sources", "description": { "content": "Lead Sources endpoints.", "type": "text/plain" }, "item": [ { "id": "9a536475-6599-48cf-9198-c4b25d0a29d5", "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": "b54a5b13-9bc7-449f-a2fa-759386eecd21", "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": "7c3010d3-c06d-48c7-9bc3-904943821314", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15a2e134-a676-4021-bbf4-6fb92f7be61a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4881f5-77a5-48ee-92aa-9919db5939c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33f7a679-aa3b-4400-9631-1589d0a19186", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec25738e-ad08-48c1-a4b1-e7dcadbc7c7c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "647daf69-cca0-49d7-9071-9c7859dd213e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4e736e-42aa-44f9-8179-3ddd7fbadd01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5956afdd-a400-43ee-941c-e35fe42d22dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77d54d3f-455c-4caa-b94f-a54fa60f4cab", "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": "29db3040-ba78-4409-9fc6-f04885401cef", "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": "49fe2985-a5a3-4ff9-83c5-64b367ec554b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c75bd20-71d3-40cc-8e34-96bd6de145c9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d08513-52be-4c05-a3d4-7830d8dfc3f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bfcd8c7-be74-49fb-84b9-3e9a3a058d56", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9fe1806-185d-4a53-8eba-4b7cba35d1d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "578625f8-8e6b-4af9-83d5-e9a9d2f8d03b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66f4b95e-4dbf-48a4-a474-e709f3e8e534", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1ea55f4-0f37-4609-98ab-02e97b5b58b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "373e11cf-4d04-48fa-b453-9a2b0cafc671", "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": "9ec762bf-03ac-45e6-8edd-e9c2418091d0", "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": "d661b4df-dad5-4fc3-a303-88f760bdef34", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c2d15b-ceb0-47a7-84ba-f9ed4c144cfb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec3eb364-08f3-44a8-9e46-a406aea81995", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3bff468-b556-4d37-920b-501adcf9036f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05d57934-067a-4718-81fd-e59251668657", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9437857-9d3d-4dbe-9a3e-2a66fffffc5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d4c641c-b3ff-4aaa-b1a1-f64448ce8563", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62704a4-05ec-4f01-afd8-dfde96b3e8b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75867a53-824b-4dc8-a520-c58172e7c3f9", "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": "7be90a09-eba7-4a14-b8d9-8d62617b6df4", "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": "f617b0ef-f766-40a1-8bd4-26e3b69e38f6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e8d41a-6529-489d-b585-b7ca7166aecd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ab4ef5-b8a2-4f9c-be09-2c53b4165abd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c65635-873f-4646-93d9-de9e09ec7ad4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9d3607a-b507-4183-9598-3ffb07fc06da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "958bd910-a841-43fe-90e3-24a8ef3131ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1df6e47d-49bd-4f89-a315-6ce82a439e66", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b869a5d-0ad5-467b-897d-fd293f97a857", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a64ddac-f7a3-42a3-80fc-b4cc41b48aae", "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": "message", "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": "lead_source_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." } ], "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": "9a925a7f-d71d-41f6-830a-f71e0676ed49", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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": "bd587ea3-ec1e-4263-aa54-9bd2cf7c4a94", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b43c0b2c-8bbb-4b8d-b343-6f63e991a21a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e1586d7-43a2-42c6-8de2-04eeceed8dcc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b98a5db1-8ddd-4db2-ae2d-dbd07a880bde", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9323732-425a-43f6-b404-4b8a98515fa3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed5ae386-4080-46a3-96d1-9c311deb99d4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c30b5b29-b389-4fb5-945f-6b1719067f2e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57f40326-a8c1-4d94-92ca-25da091ecf96", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "start_time" } ], "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\": 7566,\n \"message\": \"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": "2af0c264-658c-4079-bbf7-b02e7fd74aef", "name": "LeadScore", "description": { "content": "LeadScore endpoints.", "type": "text/plain" }, "item": [ { "id": "174a79f1-458c-4833-9ce1-26f7bb66f272", "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": "ff0f6210-3345-4318-9563-8c21d8928c6f", "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": "cd8e42de-c850-4fc8-b8d4-fbb7707f3102", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77cdf3f5-ecc7-4fbe-b5a2-f71561b6f93d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87daa4b6-ffcc-4ef4-9bf8-983a7f88787c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e93657-121b-49b7-8e8c-119d67e60096", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f136125a-4848-46eb-b0b4-21ba0b61a4d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9587c393-13e1-4b08-a543-8f4c01dda298", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a05130-f538-467e-ae45-e6b06bd35871", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81daace-8420-4a8c-9201-67585ce28bb8", "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\": 7566,\n \"message\": \"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": "c2f81767-5863-4c5d-bf80-1cd329a3d3fa", "name": "Locale", "description": { "content": "Locale endpoints.", "type": "text/plain" }, "item": [ { "id": "1fa102b8-6098-4465-b693-3c4398ed5efa", "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": "5575f12a-37d2-4fe4-a7b2-1365ac4b7d66", "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": "f19dc8af-0163-404a-9e7a-4c86a3dbef93", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61b43608-dbc3-4e47-8d96-4f94e19289e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e127b473-3efc-44be-aafe-923dd6419e9d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "072b18ec-30ac-430b-b4d1-bfb7ec95bedf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b0f8c8-6903-47a5-833a-09dfd2d808a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac38f57-f980-4be2-92d8-4658dd2b2b4d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b46119-d02b-490a-907e-866fb4215df0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78020335-0fe0-4074-9955-14706ddd6ea5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "003f5251-5c4c-4d42-99c7-13a402efc190", "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": "f2c61ce5-1380-4ff3-9060-cd63c612b400", "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": "5bef7076-df5a-4ea5-8da5-ea3d58560bb6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "758a470e-23c8-4b00-b9c2-52a40a2bb33e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a124fa3d-054f-4acb-81b0-da89ace27980", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "296445ca-9d17-4760-85ba-4d8ce974bbb4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e92dbd74-d5ca-4fd5-bc29-c76a7df02b63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65a25a30-f8dc-490a-b6f6-5d406910b49a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8bd4377-bfe1-45f3-ac12-8c29c1ec397c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9dc3e8-848c-4f07-b4e5-ec8be9f84480", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a23ee088-fc58-4c8a-b893-d38035faa1ce", "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": "acb2048f-e1ac-49bc-ba27-3b50bb2a2bf7", "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": "4cc1f150-772e-43db-b9cf-a5d576853ac9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5dede57-9fb7-43a8-9a44-e889233578e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da06adbc-e74f-4492-8bad-f1cc1efbd443", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc2b1d9-7cbd-458b-ba53-d76680c9dbdb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "489d86f5-62b6-44ec-83fb-5bc4776b8de5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dfad79c-5edd-4bd0-a6da-8479e85ec8de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d97e21c8-b17d-4d11-be81-e08cda0a58a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5ec4e71-4055-45ec-8be0-5735f3aca5da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46bc7bd0-c133-4014-963d-551824508ce4", "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": "f54d0bcc-3600-48d4-8243-c6ba5041d344", "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": "a05d1c49-cee0-44d4-aa10-4fc33004fe34", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4aeda0d-d7c2-42cd-ab35-4d61a81a1fd9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6717a64b-183c-4d3d-bc0a-40851e632669", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be10b856-ad69-48d6-a515-8dfd9189250e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4106a020-2f33-48a4-9e89-16212af82492", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d83eb09-6d46-4892-a330-544a089ba3a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bdcc236-cfe3-4f40-9dfa-cd2d5976444a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623a9c88-3d3b-4634-9d85-c6bc49455fac", "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\": 7566,\n \"message\": \"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": "a59e91d3-3338-4387-8df0-24fba12ce682", "name": "Merchants", "description": { "content": "Merchants endpoints.", "type": "text/plain" }, "item": [ { "id": "959c43fe-aaba-4975-89a7-28091766c093", "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": "81a25731-8b36-4016-982a-07ebeb5effda", "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": "262a09dd-f30e-482c-981e-ddcdf10d547e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a742bc-6802-4871-ae21-44492b173837", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47695e13-1fff-4139-8dea-ed1fe491918a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c34694c-033d-4cd3-a0cb-2e0ce9ff04ec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c949e50-3e9f-4066-960a-994a76a73ef8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb18926-bb3a-4c12-ba48-6a8971916fcc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a5630f4-f953-404e-a7a1-c8f1697c7bbd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bfb2920-604b-4443-b43f-e59a9357300d", "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\": 7566,\n \"message\": \"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": "8a5c7d1e-dc9d-48bf-98d3-f052d8222163", "name": "Note", "description": { "content": "Note endpoints.", "type": "text/plain" }, "item": [ { "id": "f98e4c1d-499a-4f0a-a31a-851d7b45e021", "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\": \"WHOLE_NUMBER\",\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": "655a8353-c9f9-4fdf-a90b-1bbff0b7beb7", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "f565960b-bbac-4510-85d1-d17c34bc59b0", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eecee606-cfb8-40b4-953a-3232c9d69452", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5194e8ec-52a8-465d-8850-a4d207c6b831", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0f096f4-d7ca-4378-ba57-e37c7374d365", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca4ff06e-1cab-4fc9-8cf8-2bb07433998d", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4783c51-cbd2-452e-a7c8-d9b5f05ddac5", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9af0be6b-f5cf-4694-9292-f987ace87c4d", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c748f6a0-7cd8-403e-9e11-03e05cc1fb18", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4263d014-948c-419b-9719-4dc41c570d70", "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": "8407f39b-574d-4946-9d1c-52c8e0451c1d", "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": "746bfd55-451a-4b84-abe8-fcf96daf4a01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1b39a2-7329-4009-aa8a-2efe53aa3f76", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de92c795-0bd9-4b2b-85d5-7322f489f086", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b630c802-37a4-4524-8060-84e979682d3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba85490f-cb2f-46a2-ad60-6c6c73d68f7e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "820a74aa-ffb2-4354-a0b8-4cefd4f51982", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "118b21ed-4784-403f-aca3-0d7574d4dbad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5e80b6-a1ec-4a76-8faa-ebd958d083fa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "912fe1ea-5be8-4e66-b88d-31331700e2a3", "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": "daab62f3-6d9d-4007-a670-64a71271b161", "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": "24c5ae52-66e8-4cab-993e-efd2112d49cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d29008d-b945-4008-9d7e-b08eccb98ec6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f41ece3-a872-4ba9-9c79-67c18f178a95", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b5be84-5cd2-4f5a-bb69-b732a1e570f8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791b656d-449b-4f77-9782-bb313fbafe22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0657d69f-df9f-4a70-8646-7987f7beebc3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4a30f81-e584-4bc9-b5fe-b77fd87836a0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "532f8628-ef3c-4027-aecd-fc3d3b63ef03", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dedfab40-f343-45ab-b8a0-31f156544d0d", "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": "6c38dbfd-906e-4af6-8591-a3ae465e8d86", "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": "8250b300-ab52-42de-b3c4-fd2c90b2685f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe6d8ff8-1bee-474f-9976-5e85c6cec68a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c62fcb1-3649-474a-aa79-f716a89cddea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81dedae6-a3dc-4551-8e1f-6ee318953787", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7192cb0-8a67-4fe6-9d5a-e3d73cabe574", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1a569ea-83ee-47e8-8bd6-4d344232252a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abaeeeae-91ae-478d-924c-e43a8889d1c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd39d33b-7dac-4f48-9080-b0cee1b377a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41a95261-b3ad-4794-848f-ae212652b7ad", "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": "17dfa9d4-8441-46c3-b6f9-5a15a4ca33ac", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04084536-b72f-4a52-a73a-ec2e9ca08b37", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cacc14e-17fe-4a28-ae81-3b9e0ade7fce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beb9e593-6fae-4ac8-8503-aa22a26dcb72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb1cf18-23a0-4a06-aee9-5563a728a44a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "103b5e26-15e1-4455-b4b6-ed0a7993b58d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4453fc3-6ff7-42e7-9c95-92c10fb17cc5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "162aebad-a1ae-48ec-99d6-211aaf5b9f1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f7298c0-a856-4be1-af04-2c9aab497626", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d442d2ca-4792-4e22-ab3e-975855033054", "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": "81c71e66-3f21-4ec1-a6f8-e323b559e827", "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": "1e6bb4d5-9462-42e3-986d-0cc2d732a9e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0e392e-60b5-458b-bea9-5811a3b9d74f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3fdfc6-b1d9-4a30-91a6-61e5cb54a088", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5a49c30-9066-4556-bc06-9c5693e1fd63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69922f69-32a0-40c5-8034-e57ff2137fad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c2447d3-ba47-4c03-b3ea-d1c4c8be8db2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37d8b5ec-fe52-4dd0-9d9a-f73d036b268f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bed88095-2117-4df8-a2de-82077982ee2f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c273d3d1-6922-497a-832c-3262eb7e9c60", "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": "decbacd4-f53b-46d6-afc4-cb831afeae2c", "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": "5641f749-5b93-421d-88a1-d9c74ec9a348", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f90d0e1-c855-4770-983b-279723b8e5a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fbae018-8900-4b8e-932b-1c6c6274fe80", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fa33dc8-21c2-4699-ba83-12a8834d532e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcf9be10-9bfb-4fe9-9c03-1e19a758ca5a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "941a585a-3f76-4031-9e2b-736866241ae3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7deb185-a4c8-4fe6-896d-3a3ad757546a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a95c097-c703-486b-9a27-21a8b8b7c120", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76732d2f-0269-4088-bbd0-7cd23f64077a", "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": "bf944f2e-f923-432b-837f-c66854b06e15", "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": "5a559b2f-7f25-4bd3-9465-694d90be3ee4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521f4366-aa5a-44cf-8a3d-f15624020006", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c792df4-e3fa-4c88-962b-8d82b8a398f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced97f25-d693-4952-a1a1-a36a872916df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9d37e0e-f9f0-4427-8b01-20f4efe00220", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d118c76-e70a-4def-8e8c-3707b2240556", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae6293d7-cc2d-4b89-8b5e-3de96acc4051", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c9da9bf-de0d-46c6-80af-e10ce151c326", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f008a68a-ed69-4047-bf1e-6963b356740f", "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": "options", "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": "group_id", "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": "0e950a10-d4e3-4aab-bcfe-fb34d779c70a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "5ecf6e91-bf00-4069-8b06-032719cb1118", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31617091-a8b6-4bfc-a7a6-0e57b9984195", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074429d3-6b09-45e5-b86b-3582d443fbc3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a375606-df8c-42a2-8563-dbbe54295d36", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc98ba78-89b7-40b9-8bef-5b8d701d21a3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8ac202a-1811-4e4c-92bb-7c1567e90001", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44982b95-4a0c-4cc1-9e63-9bd2d0d1d3bb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc5b710-f3c0-4321-8d3a-a517c98ddbdf", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "894cb0e6-ce3d-4289-b1c1-d95735aaf128", "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": "c806233d-e56a-4a45-b67e-12c3deb6c619", "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": "35a2ea6e-0a6d-4bd4-befe-cbf3220752ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed66a55e-9118-44a5-84bd-640b1bad209c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a4867c-1577-4aac-921a-2f3d23778455", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d1888f-979d-43e8-aaf3-c55a0546504b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca0c0e4-46ae-4d65-ba6e-14c54071d786", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9bf35b-ea49-4c68-af7b-f882ae987272", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f774b83-52e3-46c8-a1f3-dcbfb9c80448", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "782d9bad-145e-4856-9bee-7e99f0846159", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f8615bf-da14-4c5c-92bf-e920ac6990aa", "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": "1510ee48-e1c2-4ca2-8e81-8cf168171639", "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": "7fcf308c-5da7-4564-b712-12b8c0aa8d33", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1546c7ca-6d53-4db3-aa8b-f64539bf5c5e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622339ac-b380-4d2c-8b0c-9848fd1bc76d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ba4e043-8c87-4604-b709-eb0c5f4a8c43", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b078bdd2-71da-4574-ba29-f49164b52729", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c4deefa-f453-410b-8563-078cdff9466a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af6b4ef-9934-4ed7-9ed9-c38f5ec52e5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b37803fe-904b-4dda-8855-5f1116942bc8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b164cad-a4ce-44ac-a672-39f3cf860946", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a25d28de-f596-412d-aa63-8d5ceaf80ae2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "4ba7c175-481a-4862-b712-3ab876ff86b5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6b962b0-2d1e-46e1-a4a5-911cbed48ac5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee6fe626-60ae-4599-8fed-6e7c3ea1b56d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f495d2c9-354f-4f3b-8bbd-1086436e0bd3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96c75578-62bd-46c0-af6f-8d72435e7a34", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27bbd40b-8dc2-4d01-8e51-bdb1f88e1d1a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422e60ee-1d03-4516-8e7f-cca8a3f3465c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82a8e241-f49c-4897-952f-17d0d9e4e7ca", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79d03d22-b870-474a-b93d-b45a57fddd58", "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": "3c228db3-7bd7-46bd-b066-4f15eac18ce2", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d1a5ade-604a-4d6c-95fa-57cff5678595", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c8773f-ed66-4e42-9b0f-3148e0afae6d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8604152-7de5-4570-99a9-d7ec14fe6e07", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c3108ff-681c-46c9-9992-5e61a9483c28", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0abded66-1202-4a19-82f4-afd19714a72c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53fcfaa0-94c9-4b51-9d74-7059b0f08320", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e26382b6-7b9f-4d41-ad7e-28c74c4bcedd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfd9fbc-8914-4c67-be50-4bb9f662947f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7eb4617-807c-45cf-a4eb-e7c4d0e0f5ec", "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": "9dc858ed-9b45-4a11-8911-348399ea8771", "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": "3f98108c-eee0-4777-b4fc-8d51925451f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e7a0db7-1f47-4273-a866-2864e3719558", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f648934d-c8ba-416f-a374-03469260c9c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76210ab0-3e43-4d15-aa5c-319fc92481ca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a1ddef9-4844-46ed-93cc-965a56048e7c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cceedd63-ca5d-4a23-acfd-07d7d1a12fdb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76f335d9-e009-4087-8752-31d188871220", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56147973-1fd9-45cb-95f9-f370493a9dbd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc720a6c-b1ac-4c82-93d6-dfd4362fca36", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a9ea13e-d0f3-47f8-8ff2-330b1b94f4b0", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f80bd764-6efa-4e51-9476-3f63d05116f8", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10014593-56d4-4316-ba5c-1be25418a57f", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cca50ddc-bfde-4242-84ca-d9eb93c4c5e2", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d37b5b01-c3d3-4863-a719-93a62f7b27f4", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d061fa-065f-479a-8b1d-2b6bac7b8f30", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aaf802a-60bc-4165-a3aa-d3ac3a5ecb33", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40e4c262-126e-45e0-a875-3534c678b0e3", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbaef836-a669-45e1-862a-8bd8c6c230dc", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "610d88b2-8622-48b7-8e4f-70a1990356df", "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": "605cd374-f684-45bd-bdb9-f087fc7d9db4", "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": "edb67d35-0682-4d90-ba46-ea0a6625b91d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3bb5b84-dd24-4cfc-b118-75dd41d15db5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60c0f69b-1060-4731-9577-57dbb0e9ce9d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9adc7baf-0778-4643-99c7-e077aa8652d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b42a1da8-80fa-4514-907a-86d4fbf429e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0262e0ab-eac5-40c0-a587-bd9085052b08", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cfb3bce-f17c-41c1-accd-509919ff8435", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5bc4cbb-41c1-499d-b55a-780562d62bc6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "793a5249-5bb1-4a1c-901c-06eeeb0f3e63", "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": "6be33acd-ea04-4031-9104-5b72555d9998", "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": "dd4d9009-c6ad-4046-8a65-2c32b75747f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cb350dd-2c09-4dc5-990f-addb6da2b27f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "267a37e8-a63f-4cc5-ab11-94c6e85b7876", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dbd3b83-13c7-4954-bc26-b938441fd46e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9331fde8-cbbf-4830-87c2-42e70cb6e16d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db0598e-c93c-423e-bbfd-514d219bb6a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a842c6-404e-447b-9b8f-a8e0e496b291", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a503a01-7867-43b2-915a-2902cff37ad0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a7f755d-af07-41e6-8638-08ee934afc72", "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": "title", "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": "text", "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": "34f15a60-a3da-4ca9-8c49-3a0c6e0790b2", "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": "type" }, { "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": "79976a0d-6c08-4d30-8415-d079ea818a80", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4d691a-974c-4d10-b0d8-c96cce19a892", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1266d1d-1e13-4247-94ac-c0324673faf6", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36ae2978-7441-4545-bba7-341a80f18520", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11be834-2c91-4523-b081-c9db760e9255", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "894760a8-b12d-4dc7-b374-384ddd2c068a", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85d88b80-db91-4fde-b372-cf536985aafb", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "389ed40d-3e1a-4ff3-83bd-c89526a63072", "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": "type" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3eff2c55-b861-4124-9da4-cb9d67c168d7", "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": "d1a4bda1-29f1-43c7-8fda-b33e31493145", "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": "628984c8-669a-449e-b482-a585ca2cc05c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c8cb50e-e569-4bf5-8d45-0541bb113638", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bb72c9d-3f07-4180-b92a-2ffaf91b9e53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aa55077-1842-488d-b042-d2a9b17fafb6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66a327fc-c8bd-4b0c-93ec-550b21d5c23a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a54cc541-1998-428e-9905-2accf203424b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16ca12f1-780e-4d27-b844-7df1f1c8f29c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e514468a-68ec-4bdf-87d0-17daa4ca7e0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1fa6837-40d0-429a-9be1-bc5de6febf98", "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": "f84d3805-3998-4e49-8eee-3d6a1cb3feee", "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": "4578a44a-ba5a-45dc-9023-57c039f0eaff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff8ff0b5-a701-4926-add9-6aec4c45b37f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5a52f15-cd2e-499d-85aa-e3a734c7667f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af72e89-08c4-4e53-90ab-637dacf89aa7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e3a0bb-300a-4bc2-b4e1-610d03bfaff4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bba4fa4-3010-43e1-a1f8-2d12abf41a77", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9f516e-32b7-4230-9b98-a2d6626db6da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4f216b7-8a8e-45d5-950e-3b1746fafaca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6faa656f-ae23-46d9-a276-f18b6f2814ec", "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": "9a7dd301-57dc-4233-a137-79688efd6b56", "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": "1b0f069b-e171-4fa1-b496-9daa4f4b1d29", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074fe051-d0f9-4242-a408-b6972529c726", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe974d9-55b0-4219-b95e-47842966ecad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53136dbc-7dcd-43f7-864f-3c2af409ac48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fec5f165-f288-4744-974b-17dd6dfde7d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b79310a-889a-45fb-9493-d78d9f82cabf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09600fb7-071e-4a4e-8606-4533b67b23df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7930108b-b728-4655-ab59-06f1847c928d", "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\": 7566,\n \"message\": \"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": "0b83b89b-e2ec-41e6-98d2-21f3d76d2c00", "name": "Opportunity", "description": { "content": "Opportunity endpoints.", "type": "text/plain" }, "item": [ { "id": "7d979019-459e-4bb1-91aa-48251f1c56ed", "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": "custom_fields", "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": "status", "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": "2a1e67ef-65a4-4c4e-a1b2-c98090fe4d03", "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": "last_updated_by" }, { "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": "ce910687-6692-4afc-ba67-db7278caecd4", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7b2857-a01c-42d1-80d1-60158d9a0e48", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e4dd05d-ecb2-4d2b-a4a3-1db8b38ace60", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b9a6586-30d6-49ca-9bdf-dff0cd2e5bad", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4541eeb-ee1a-43ae-9296-07113985fdac", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31861bb8-9cb5-4226-8886-540079b41b75", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b41bef1-4634-4e1b-a555-e6bdc4c5caa8", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b3133e3-7cfa-4a36-84a7-cacb4e403f2f", "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": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38d1d4a4-7f44-4467-af22-a0afeeeb9302", "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": "custom_fields", "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": "status", "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": "865ea1dd-8d03-4f2c-852c-62957676e78e", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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": "b3c3e45f-45a5-457a-a694-916af7a7102f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5972b45-0639-425d-8106-fae3d7ff1023", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66428edd-0971-4ac1-bcca-25eafeede368", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d69f4f4-3dcf-4608-b32d-5d9afe9b89a9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25135974-e9c1-4323-83d9-0edda0fa75a8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e62d8b2f-3d30-44a8-95e8-60ec842d22c9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4045868a-f36e-4fed-87fa-db13de820276", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76706bfe-62d7-45f1-a1c6-3460143c930a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55eef1e5-373f-4be5-920f-8e4e5fad98b8", "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": "f8ef7b43-32b2-4e0a-ad0d-622f6a3b1dfe", "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": "6313433b-ced9-406f-ac5f-4cf0256ab86b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30812303-b5ba-4aad-b91c-136829f1f5de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f2f31bc-7553-48e4-8fc0-c4986b8277ce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ddca0c3-83c1-4b4a-9f24-4bd84a74bffc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04de15b1-7451-4714-805f-61cbe84b4c2c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45825ea4-c06a-472d-b335-0ca724f0f6de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db00b9b-47ca-4dee-a0d1-2ffb9b4f2a5f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95dff5cc-96d7-48b7-af4b-6e33a99191d2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7811e963-6865-42d1-9f74-8b876856098b", "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": "2e9295a6-530a-43f5-b63d-73145626648c", "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": "2f4f9c0c-931f-4422-8589-37783f1a49d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "069b0770-c5ee-4137-90e8-56ddf9b4f6d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a16b068-e08b-4460-bf09-ccf5afd03478", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb68d4d9-2ac2-44f8-bcad-4eac6ec4f78b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814710d6-2dad-4fd9-9607-30582caaf8c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d72105a-c399-47dc-8fe3-a0a82aea28d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6edc61f-da60-45fa-ab9c-cefc8fb9b8cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a822a487-3042-4d72-9f7b-d8cde3aac039", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93e5fd52-e205-40bd-b03e-55293768c379", "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\": \"WHOLE_NUMBER\",\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": "f8920f6d-e9ff-43b1-9c32-a306247077d4", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "1038bdec-1ba8-4516-bc39-8d8dce3f7c2e", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c6f52a-5645-4b30-b31e-3ac40e5ebbd1", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1ca6e0a-676f-4694-bfad-dbdc73d36299", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "944c4830-8426-4311-af2d-8cdd2666f942", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7da9df5-a76f-4fae-903c-a492a364c34e", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a530dd50-ca83-4fd7-b528-5b386e4ad969", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd95350-e9b5-469f-bdc9-50225de00287", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f9d449-6463-455e-8e70-54b972d15c5f", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1750f09f-9232-415c-885f-5dabb656b2d0", "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": "b0d5dca5-afe5-46dc-9ef7-d44e027134a1", "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": "fb6bcc83-d8f8-4d10-9ab9-72fb0269abbf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba15ebb-7171-44e7-aadb-2c4dbdf9651a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3918c1c7-8b13-4f8a-85f6-edf0277ba4d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92cc82c5-96f5-4a54-98c1-f84eb2692c0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7441d29f-ff2b-4f94-a069-97a9345d2c30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "221a922c-add0-44de-8dff-c0bd7c8b3040", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1750d62-1ff3-4199-9b7f-da4c3e77bdf8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1db9a7ab-6586-41f9-8fb9-51cd9fe8cdc8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42c199c4-7770-44f4-bf93-bbd20fd4f6c2", "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": "0c7d7530-0ba9-4d7e-a26e-6730ea735a8a", "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": "2895c3ad-a20c-4c0e-b6aa-2d687adfc4a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b0facf5-aaef-4363-9052-aabb50f09552", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af6d801d-90d6-4f0d-90d9-02853709fc7a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd5e009-1c3c-4104-bcda-b42d34212fe7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d209bdf-d246-4e50-923c-1526aeb3f77d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69cd2f9-b558-417a-8506-adaea9e36616", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0af7ff7c-e2d4-49c4-b31d-3b38f1d55a22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "788ae43a-5a03-4caf-9c8c-ff70b6398948", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "795dfb59-96de-4d87-95fd-25bf80a229c8", "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": "6f50e96c-aecc-4d98-950a-405b26a78849", "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": "811687be-84af-440c-a2e6-5fcc3759e7d7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2aef1aa-63f4-4a8c-a0a8-7a84a3aed5f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d604c5a-4143-4610-ad6a-386073edebcc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c6ba9c4-f148-4526-8d23-f79645eab592", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97ad28c8-dfc4-4e13-8178-63643090dfa9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f0020a6-c32b-4320-90db-5f6e6123e24a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb83c1ba-a9e4-40b8-bc4f-6493d4ee0876", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "006a5d42-725a-4069-8da3-87cc1df33872", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c6250e4-7ace-41b8-981d-03975b750d96", "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": "17a869de-7c81-424e-b2fc-d0bc4502b660", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff784362-1786-4ac5-b4e6-189d96c2a248", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e5e2d6c-9942-4681-9449-e5976ea92a52", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81598de0-7fdb-4d59-8877-7a40e5de7c7e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16037e82-a40b-44c2-a385-02ab9af32823", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b1a36b3-ca8c-4747-9e1b-2248d9f5389b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9069d05c-dd90-4d78-91b0-c701494e4e59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cf2064f-0ff8-4508-8a94-5c1f5316e051", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95ef2a4c-5a3a-41e3-9726-f7a80f153dbb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4af267e7-8af4-4266-8300-1c7cdfdc15b4", "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": "custom_fields", "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": "status", "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": "81ce7573-13b8-469a-a98d-12d1d4c57ac4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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": "9da3e447-5367-49f4-84d2-3e03888642a0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2616fff-4169-4e70-9fa3-9f208c7cb3bd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6512cb92-0722-4332-82b2-9bc35e7f2f43", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74fbb1ec-e942-4aaf-a35e-86565911f037", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "398e6bf9-f925-481b-8d97-bdf11713eabf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73127771-5c15-4df8-b988-81f6668e9f1c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b83b14-54ff-4371-a0ec-a5d528b857f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85f2356d-ed95-438a-a262-c01cdc54a388", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b48f8d8-7b66-45f5-baab-bd3113c88e6f", "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": "585324af-e56e-4c5b-8573-8e26863369f2", "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": "46f403d8-cb85-438b-adda-cd3d2ac00b99", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceef64e3-4684-4ac3-9bb6-1f5abeff7a11", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f25db1a4-8275-48c3-b2ca-041d0f9f379c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43a1910c-db24-47ff-9d61-6bbfc6f961e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "012eae39-9f30-4c20-85d7-7da38a74659b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a29448b-a624-45a5-b5a2-49c2a2751ac9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8dcf493-fef5-45ed-97d9-e4a298c944c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6da85879-7752-4681-928d-b8375140a3b8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a8d028d-f975-4274-82f9-1c075397804d", "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": "next_action_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": "affiliate_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 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": "status", "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": "0b1a00a6-311f-4da0-b613-89c89c468778", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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": "bab161a9-36a7-4c4d-b361-57f666388207", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e935f8b-85e8-4e8d-b603-1867529b82c9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49e7e1dc-6cc4-4531-9ca0-05c2ba11f62b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149050e6-85ea-4e86-a8a6-e6b0e4140b6f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "709b7b8b-20b1-459f-80b1-c7224b80c38e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98697526-694b-4caf-9a2f-b8672cb04be9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d82e794b-4b8c-4605-b564-d9f133af8f92", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9aeb101-a374-4b1f-8525-9b9d7459c5a7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "include_in_forecast" }, { "key": "update_mask", "value": "contact_id" }, { "key": "fields", "value": "last_updated_by" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbd2ceaf-b434-441d-9e34-9b824a12801f", "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": "c734d55e-51c3-40bc-a0ae-3fcb3f66dd8b", "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": "274ac50a-7265-497b-a5b2-f49d672b5fc0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c3c589b-2442-4f19-a08d-d3ab12c0c4a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5325c48f-6424-4d83-adb4-df3f6a35553c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3380fd6b-ca6c-4b69-9669-e353a764202b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8f7f9b1-5838-49ba-ab2c-1d9984cae0e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90480466-0aa5-420c-af73-beb2b7fd6781", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49dd7091-74a9-43e0-be6a-9eb02486bbd5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a251a29c-fe54-4a3a-8aa1-c7aadd80ac39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd6ad255-f6aa-4735-8b17-b49d6a5aa3b3", "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": "f9ca5eef-c760-46b1-95d7-c01a655e247b", "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": "7c0cadd7-7ad4-4058-b359-0f6f9c7b8e78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78d288d9-b710-48f1-aea9-c6b998f94012", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d21628ed-c75d-4e18-b66e-a4b8612ec1c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "721fa269-7bf0-471b-9cec-d3ca1f000754", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0ba0286-cf0d-418d-a0d2-cbb01d195c20", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14efb115-9ed8-48b9-8227-ff04a0bf4091", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c824ef9-4f12-40c7-9f6f-b8d4b22614d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15bdadde-1310-49a9-99ac-1217ddd64daa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dbc10d8-0950-49d8-8449-41da494f6d1d", "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": "order", "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": "probability", "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\": 1466,\n \"probability\": 2,\n \"target_number_days\": 5821,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c90b52fd-3da1-490c-b985-257e8b0f605f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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": "42f9a4e0-ffbd-4b31-8298-a0a56a754775", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76f6095b-39e2-4a8d-bc3f-1b4f4e76d38b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956a141c-6a59-4202-bb04-c4ed3b49f4a4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e45e94-c892-41cb-a540-6bb92ae77da1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5477c475-7c56-4e2f-96b0-1149395d5389", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "636a6ae5-bf6b-40b8-83a5-335ba2fa6d58", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "028cb793-8ff1-4961-9cf8-3eb5ede5bebe", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35660106-4c83-42ae-a71e-96dfc5df08cd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "target_number_days" }, { "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\": 820,\n \"probability\": 2,\n \"target_number_days\": 4592,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "259c48b3-7c08-40eb-936f-8fc68d1d8b8f", "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": "effa1d48-32ad-4568-a858-4782a45e6a80", "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": "de402ba6-888f-44ba-a1a5-e9ed1470e271", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45cd526d-fdce-4897-bb3d-e2c35b48ae22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b682964a-4f5d-4aab-9bc1-04c20ba754fe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450fbc15-50a5-4fe8-bfbf-e5830ea350fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d65efb-084c-4cef-95be-3258e1d435a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1115e44e-a739-4d82-9de6-091d0e184629", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0918f9c9-de7c-458a-9810-cb2964073fde", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ecd00df-61af-4b3d-bad3-10a9448585ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3d0a54e-f6fa-4935-a34d-fa542c615776", "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": "options", "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": "group_id", "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": "5a5b2a01-a04c-452f-beb4-abf6e186708c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "43d861ee-875c-48c9-85f5-1118f51307af", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "563ec35b-80f1-4886-97e2-256bbd505bcd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05cc3cf0-d1f0-445f-a142-cb6d0b76cd1a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4d61e05-77d0-4e99-8641-16e8671d19dc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0555ab1-8e3d-4e66-81c7-d07518d5a849", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2e59576-8f94-462b-8e3f-dc98609f6049", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85adceb8-92eb-4af7-9ae4-3879c9f3b082", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d298617f-542a-41f0-a5e0-0c987347de8e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e6fa936-9fe7-4bea-b1bf-4d48ffba507f", "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": "b40048a4-4a43-4191-a871-9e4b0ff45601", "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": "daa3de85-7f16-4220-b497-ba636c0ea9a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "141cbaef-6fae-4d45-a507-fcd1ecbff945", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f7a2c8c-bb9e-4be8-a614-a647a00a2582", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b970deb9-a36c-4ebb-9ea4-94d38903353c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd72339-3b00-45db-af55-e6667b6c9760", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d843159f-4ab7-4f6c-9bdd-a5b9aadc9e30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49bd2eaa-f61c-43d0-8173-99abe381fb72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b208316-9cd3-4efc-a124-753cb3c64e23", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bac7f65-8f58-4c5d-a7b0-8b74892ba96a", "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": "49bb5b88-8e22-42ee-af4b-46cc34ef9be0", "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": "54cfec65-45fb-4b3b-8692-92bf7523ba59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea01ce3f-b3be-4af2-abb4-c0aebaf632fa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4020500b-5c4f-48af-b76d-4b21091b2391", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ecd49f-1aae-4318-8337-c3c1220b5ac7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b5b222d-a80b-4e92-89ea-172c6dae883a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c364a2-07b9-404c-ac3b-ff8145aa785a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a65e78f-11dc-4e43-8e21-5e21c666395c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ffa2c5-f38a-4b4f-9a08-3e0afb82ef83", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c27498c3-768e-4542-927d-4536e15ef48a", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e0c15e3c-541e-4725-b7f4-d160ebe0f99a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "a4961269-bb84-4b9e-aeaf-c7f2f985bd48", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a825fdfd-1527-485e-a505-1879a0769c78", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f5b0355-90ea-4f38-a61b-a62179cc4a97", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "152a2349-ce34-4ead-b703-cf7c1520e465", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0cc122c-26bc-40d1-adf3-6cedd749f941", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7591fb7-a680-440a-bc16-aab84b040ead", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1086991b-1bf1-4f8b-bf55-3e4846c9ce4f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "851d2030-e1ea-49b4-8826-02ce8099479b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e24b0e0d-65b7-4643-b6fc-d2c91cc8e618", "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": "7ea05789-28b2-4ac5-9148-a5b79de736f8", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d957100-837f-4e09-978b-6df5c37f62ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6796042-73aa-4c09-91c9-b10af77c0692", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2011f15d-2e3f-42d5-a7b7-d4793737a8df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b6e7b3f-5a11-4b9d-bfd3-b94e5c84b9ee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886f5a33-dd08-466c-ba6a-23a581e8f74b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4180bee6-6c97-4b14-a40d-66a89b47adb9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6ebfb20-f697-44c0-83fa-2298427c112d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8eb7122-164c-4212-876d-e19f447d04e6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5eb2284-538b-4dc8-8b1b-e316e69d7e37", "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": "313173f6-ce50-45fe-80f1-0e72d16520d3", "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": "c4be218f-4e0b-40d1-9a37-2954a3d95845", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d587d882-5e86-445e-9109-3a535eeb12b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "608d8c48-e4aa-4c32-8f07-e8d8368b5cc6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c142ce-b3f5-4e0a-b1b1-48b914cf0af7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9fbf53-54e5-4818-83cb-4e9e1e0a90ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4b5b7e-2132-4937-be50-ef1f9294d07b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7b785e8-0e5b-40bf-8db4-916d135687fa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5296158c-cc54-49e4-ad8b-f5fe89afa301", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7a01ebf-a4a3-45bb-88e5-479455c41506", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "865075f8-4115-47b8-aa12-cf2e190543f2", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6f7a7b2-a263-42f0-80dc-242c014c634d", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "891e531e-5f57-4ed5-85d8-03b47d3d227b", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bb22351-547e-4f91-bfb9-b0427b1dcef7", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4d1355-5cfe-492b-b62a-27fbf1aa90d4", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d70339-74bd-4abd-98f7-bebffd427bee", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc6a05db-db14-4a97-ada1-e4c51808280a", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ebe0d6d-6bd0-4623-b656-1bdff42ee479", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7427eb21-62f7-4da1-8147-0c059af9df2d", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a5bf9d4-e049-468c-866d-622631e0d9af", "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": "83ff9b2c-60f1-47df-9fd6-97ca5e3d7948", "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": "553cc941-8c14-4fc9-a123-fdba4fdc1497", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fa99b9e-e121-4421-861d-6a293f584ba0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96bbd2d9-18f8-4f65-9dab-ae744a73281a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8277d3d6-78ce-496f-ab60-ed10518f8c52", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1597dc9-8c89-4fee-b3e1-e03c6110e5ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e40a8e54-080d-4d82-ad01-52843804e753", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081682eb-b329-40d4-a74d-b547d1c4739a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56518bbd-672e-41fa-a34d-2c9c019bf160", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b2c7ea7-e6c8-4260-816b-a5c6be17c72c", "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": "ce532a68-ae89-43de-bc53-4543546880b6", "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": "56b53a30-da4c-4861-bc8c-4a67f501dc5e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0301b842-d207-4ed8-a962-d2874acec0c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef4e1f7e-17a2-4521-9392-b311d7e495ea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd62138-aada-41fa-af1a-759770bc9661", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdd04da5-df33-4212-a03c-b13145f9977f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c68096-a55d-4340-bdea-37211d60f515", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f55253b-1f28-4e10-b8d5-c19bcc88ca6a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0096fc8-6bad-45e8-97d3-2ea6bc5bc971", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cc7e3ef-495c-4de7-85e1-3f1864c83d6a", "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": "4c8569e9-341c-4789-9213-62dea52b6c59", "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": "81ca6aa6-e7fc-44bd-b96f-de9466081ca6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "532754c5-c5fd-4320-9a3f-00fefcc26af5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca265fe-741d-42f7-95a7-b3578c462a23", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12ee1b22-4f51-466d-817f-724b701e2e3f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60b5e613-3487-4fab-b9f1-3afb0d42ea6b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4611dfa9-361e-45e5-bb0c-6784eed1c774", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba94568-ae63-41d0-bfff-60b33b5d4c59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcefc361-a298-41a8-978d-6278a5ec0d15", "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\": 7566,\n \"message\": \"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": "de3e5b32-932e-4cb8-a8ef-575cda94f98f", "name": "Order Total Discounts", "description": { "content": "Order Total Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "dad767bf-4aed-4b4e-864c-47a6795bf33f", "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": "d0d81fdc-09be-49c0-be1a-2400dac449b3", "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": "62118ea7-08a7-4435-a3b7-4f843ae9fa1d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aab4de3-c19d-4385-877e-94932f8e2274", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c9fb0fd-6cec-4a8a-95d3-8bc608f6ccaa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a2540bc-90bb-481c-a6b4-9deaf7966ad6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ffec241-4abc-411f-a5bc-1b49947c3c48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1edc0d0d-ccd1-442a-b05c-5e26e8fd8e4b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d757605-38ec-44b1-b377-fa6388d28a4e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c267199-c579-41ac-9977-f0690ba84fce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b151b867-b474-45ef-9e23-b3dbe4b89b24", "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": "222eb19d-dec3-4b2e-8bc8-e600947b1e0b", "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": "a1fdf3d5-1160-449d-bdbd-11b01aca49b2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab1ec84-2469-46e1-aba2-84d7e728302e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4fbce3c-6e83-424c-907c-cb9131aa16ef", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "193312e1-596e-4392-8072-64becd6c1cd6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aebf3aa4-0bae-4664-b78d-8c5e5b6aa699", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60576c22-4285-47c6-b3b2-ea81b388bca5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc11892e-0b86-4b41-8561-4cffb37cd0e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb1e668-129a-44f5-843b-70c5585c751e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48319d34-bce5-44f9-8a5b-0c69f3780737", "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": "5567a3c0-05e2-4dc7-aa5d-43eae6e7f97b", "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": "c9233597-0d73-4486-9a7c-623e2639d6bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e15bf918-e481-4b9e-a1fc-00027e5de206", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2de6b9c-17b0-4c49-8f89-fae11cd394c4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fded448-e3f2-4a06-97e8-392a110fa388", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1018390-18f8-43ac-82e7-c413ca58b883", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4aa9885-c17e-4b9d-8ce1-bd18b7954302", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af33c4f0-4baa-46c5-8ff8-8877a2f69a2a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1acfdd-d86f-42b9-a622-98ebe0c4f334", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2743c248-b2e9-47fa-863c-2e3acdaa5a48", "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": "0cc573d4-204c-447b-bff0-57c3c4c58bb1", "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": "c8a02f6c-31a4-4e4c-aa54-b0dc28c4906f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7ce165-8b6c-456b-89bf-ae080539d419", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "963c864c-9010-43ca-bb27-aa423efa0557", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bb949c8-44fe-4bdf-b8b7-251248322c3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652826a6-a407-4426-af1d-e8ff5f4b1222", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5582dc09-fbea-442d-8728-2dae27f1618b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0132f34-9508-4841-a64c-8e54303593da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a54093ab-6e62-4635-a3a7-3ec30cd7d9ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecab5af9-6603-4769-98c2-97b308cf622d", "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": "d2817fee-fb56-4895-a85e-cd7caae4e125", "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": "611e50bd-832f-4d7d-b8de-b3cda0728bb6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c383d24-fcfe-4c4c-8a4f-32fdb8ebb9e6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa7961bf-b819-48dd-9b31-a00121435039", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1df787b-7633-4dd0-a261-052d3abfc7e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3dc202-6181-4854-8941-35c18d86fad3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27b1242-93ee-4e56-8c92-13319d130d1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd9aa2d2-23bf-4046-adf5-ca5ac93bbb7f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c954baf-9ca8-4601-9311-5ea96c9decb8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "319a28b1-4d12-446d-8af3-3e647cb65fbb", "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_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": "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\": \"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": "ba322191-ba32-4489-b56f-3f6eb03a1ce2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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": "00ab4a1c-d3a9-4513-a3ad-5ac7a20732c3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2e15329-97b8-4fbf-bb50-098a1580e7e7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75d12f62-2029-4395-8711-bbe9fe9a3e31", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75fa6c8c-79db-4db2-9c4f-b02fd98e0f74", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41c5fe15-08bd-47f9-a78d-32d8ebebaca3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a442c3b-43af-468e-89c1-8e71716c353c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dec8eef-471c-4811-ab91-418b9055d8ad", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d773d86-f7a8-4c0a-838a-aa563acce1d7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "823baa6c-0418-401a-b500-f0ddd72e4d11", "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": "96868c64-3554-474a-8f0d-b5582871b31e", "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": "d86bd87c-1009-4df2-90a3-cb1770099da2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e458650f-4acb-4a06-a6e1-f938efb0a0bb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f6da539-4f5b-4013-897d-258cfa44ca8f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09d4c375-25e9-4161-9d69-074699baf53c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db27fd05-b7ee-4237-ae79-5eb0e2adb253", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e5e85a4-7225-4f70-8b12-e31a1eb68c16", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ad7c70f-1d95-49d1-9b24-9b425159422c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00bd20bf-098e-449f-81ac-1b2f1911cf37", "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\": 7566,\n \"message\": \"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": "2993ce45-0283-49c6-ac5d-b807157f7fbd", "name": "Orders", "description": { "content": "Orders endpoints.", "type": "text/plain" }, "item": [ { "id": "06e45a28-c190-447e-987d-c364a34f2231", "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": "aec5611d-774f-4e90-849e-f3e05b1cc638", "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": "a4192a0c-d509-4ed3-a09f-313b7b23016f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f55acddc-4e2e-4906-937d-a4c4ea42ff7d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3499dbd0-cac6-4c04-a795-b2f4f4ace688", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e7352b2-76c6-4b03-87c3-f4b6971145ef", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded96c0d-da51-45a5-ad00-abfebc065546", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff5f1a92-03b5-4369-b490-77a3154c733f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e978525-332f-458a-86b3-26c33a578824", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ee9dde6-364c-46b2-a88d-2845d4d1eee6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8ddf565-861a-4ced-9112-4e7f65337e1e", "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": "9e28801d-edd1-47ac-a505-975b280889ba", "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": "09f4c58b-a135-4ba8-9896-bd8f56ab7b66", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a87c0ae-6528-4399-bd58-66df8c6ce97f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba48176-6bc7-44da-901b-ad67387d937f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6de2126-ff9d-4133-8326-3258366048b3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7fb102-40c9-4550-9cc6-ad452c472a71", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77e1fb11-e18e-452c-b41c-d3b44d6fa76b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90af2d62-5992-46b9-8551-aad19a560e03", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8ecd9cb-f4d6-418a-9045-f26a6ff3e1f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "989058cf-2c57-4f76-bec9-d4fb2c524d89", "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": "d5de57b1-6e91-4991-a803-3c44abd27880", "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": "32d779e3-3992-43a8-870f-33c31fc43b8c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4367c0fd-83db-4435-8631-5f62bce5a773", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37933a64-c7c5-4d60-848b-a553c439e3da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a0c198-d089-4f62-afab-fa65ede974d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23b347fb-7e41-4efb-9987-cb008a91e3e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409c7be8-3250-459d-b41c-15035e910d6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d988aa-ed65-41cf-85c9-7ac021eac0f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80a43e32-16c7-4f73-9fbc-a7082fafca77", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8301f3db-e891-4704-9089-f147a581a823", "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": "5cabbae1-def2-48f5-8a51-59b40443b70d", "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": "a41cf212-2865-4dc0-af25-b54cd5876951", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24675bc9-8b14-4756-8cc3-c1e88af4f5ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0f4922-d074-4cb4-a92b-e6383ec65d2c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9391c0e-52bf-4c08-9d96-bccf03d543e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6123342-2a35-462b-8514-1e380facd583", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b61343e-5d78-4099-8a33-d599503f8172", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a02de5b-22b8-4f8f-8c5d-7d36a255b33f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "368413de-ff49-491d-a786-f378d579f57b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7508239c-bbae-4e77-ba1e-d3d51a2fb045", "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": "bfabfa3c-caac-40a3-82ea-7f7b2c6a3fd2", "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": "85eec5f6-26d0-4543-8b7d-b1695f487a3e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f955b83c-c21e-4de8-956c-3345c13809d7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "381cb2e8-7c4a-4ca6-8906-e3a4d1b42e8c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37231109-ea53-4425-9328-2efbd6728bfe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17cb77d3-f651-4089-bda0-db061d82ffdc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b33a0d24-782b-4ee7-9aba-37571e939675", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78253a78-6cb1-4a0b-b4c4-eeb83465f50a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547ffcf9-ac29-4ba5-9eeb-3ea4fa78cfd2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d053a110-1df9-4a2c-bc3d-c7ed40f91d61", "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": "6c9592e6-cd2f-4ff2-b2b8-f316c8180bcb", "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": "8f8badac-3c7c-4932-8438-483a47670fbc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93faa5e-8c51-4313-ad2b-2460517bdbc2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cbedfcd-73a2-4f43-af45-512abea07632", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0704928a-61b3-4bed-a5cf-a0e78e8529c9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9713e8cc-6378-4494-a772-f55dda7943be", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2363670d-701c-46eb-aae6-bf397dc30fc4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30bd0de-9bbe-4722-834c-fc8fbde4fcc2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93cffbe4-5e3f-45cd-8655-3a4a6e73a0d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aca468a-44aa-43e4-9920-51adf5fcd479", "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\": false,\n \"payment_amount\": 2076.552605695594,\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": "7d0485ea-ff24-41e1-8cdb-a71f068113eb", "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\": false,\n \"payment_amount\": 2076.552605695594,\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": "0e2f7e51-e552-4905-ad57-756cd776b1d3", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42714264-f3ae-4cbc-9c8d-b4a34119da7e", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddf8989c-b99f-43db-8242-33ae8478f69e", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4fca510-4f9c-4500-8529-8c30dd412bbe", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d14a8673-8823-4916-b4d5-d60e75c32a49", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad55509b-6e4a-480e-adbd-da5ff1b4d704", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06ba307-dc7d-4c0c-bb9a-b9ed6b26ac20", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33be13d7-08ce-4870-ae41-caa35a9dd717", "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\": false,\n \"payment_amount\": 2076.552605695594,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd25ed07-533a-4cd4-88ae-98e8099feea3", "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": "bc3cbe3e-c522-4da3-a916-c4080ac50658", "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": "1aec9e90-d2ab-422e-8a81-12d84a9702c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e74c16e5-5bac-4afb-8a8f-f68a7f009d73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "154d56f3-db26-41fe-84d2-cd90d84f4d16", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d194aed-f24a-4b90-886f-ee062f94f5eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6e50e35-576b-4be8-8c22-85d4e7c354dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f8aafc-22dd-4839-8a38-7e4942a3ad6d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ea70c3-d88f-4cee-bf3f-bfa4e37b4302", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfd111be-968f-42d0-bf92-174a9d7cc910", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1d488d7-79e1-4d65-9b28-a25799420500", "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": "21b2ea43-ec79-4846-a80a-1b217f2ca024", "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": "8ee3326d-71b6-4e0c-b40c-b4708fb68c32", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28f1afe7-7a5e-477c-9759-2018b4489661", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "940b819b-bd97-401d-ada9-f689de23ebee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e0948e7-9adb-4ba2-a0ec-96021bef37a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08bddbcb-f13b-4887-bbf9-d23865e5fbde", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53c68dc4-8b52-46f3-91a5-e8932e83915a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5a73e3-3b32-42a6-a191-469d38998dd8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e074a6f1-a9fe-4111-a18a-f3f1ef40ad29", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fd24f7d-46a4-4035-98e6-6bb259e80a69", "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\": \"WHOLE_NUMBER\",\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": "63706967-e7f1-4870-b023-4db1304a8bab", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "bd565b83-d563-4849-b14f-5a5ebd8989cc", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b96d2d-b48b-4916-9da6-e222c458794b", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e40a337-efa3-4cbd-a33e-8b6d209e806e", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b409b3-de94-4ab7-8b1a-c84862042094", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6dfc102-9195-4e4e-9032-5fd3d6679502", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08612e57-c211-4376-a7a2-b5c1525c00f4", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba329450-741a-4a86-b23f-1bab4fc5facd", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60ae1f51-9df2-44ef-b825-bd985836db59", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "141e1561-1390-48db-aff8-761885a047f8", "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": "f05c5d54-bc86-4975-a5b5-b397501494d0", "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": "c5bd3ef1-361c-4b6f-9a52-ce74fc291a38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c1bb5e6-4fe1-4a03-a611-4cb045043f53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44faaa18-0ab0-4f84-9850-885244760c32", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eecd9e79-307a-4be6-92cf-097dd340b2dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e321867-38e9-4bc8-8ecc-c926a974befd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629261b0-e31e-4f1a-afb2-2aae35eee58d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "973f3706-4dda-41f5-ba54-31501ed76503", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec41a34-3de6-49dc-a9f1-3c59d56af16c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7d9b9e0-d99d-4c9b-91f4-23f0a7a97bfe", "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": "9c8abf0f-a5b5-4b53-896e-34135102c22c", "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": "af92ab9a-05f7-4887-be64-311aa2b02681", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33b81c81-c205-4856-9439-e82f6edd0b0e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a50bfc-e308-456d-8cd1-9bfaacfbc409", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd1b8f6f-d9a6-4fd2-bea9-1d9351606f42", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "783d0862-28ba-455c-92ea-80529551fc8c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7946dd-567e-459f-8d89-146f6af2243e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18fd962d-efc9-45bc-8942-965204f1776e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a28c80f4-635c-4fdf-b099-71178c840c88", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30871648-bf79-4ea1-bbfa-35900516648f", "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": "a99e53a0-c104-470d-b922-41d70b3df3c2", "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": "80c4dce6-a3bc-4b46-97ac-c18e5a9cf73c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc7833ab-47b0-4377-bbbc-7212fc35c29c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca4c515e-9a80-409f-8514-133819f1282d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485820ec-b785-4ac6-9360-5884af931251", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d58b5a-0b08-4031-a317-0ebffd555d04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb85d19e-6612-43b7-9fae-15fbd0a7c7d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c4beb30-0076-4315-8c90-889ed34a1b0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efab6178-2d44-43ac-a1b2-f48a9deab0eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ff9a9aa-5390-4b0c-97ab-f20bef6a9de1", "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": "a4b27595-d172-4c1a-bac3-e5aa722898a9", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed3a173-0ef7-4276-9ced-d8f475b11b6c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7977e5ed-0ff3-4719-a244-d245d45ec1df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ce5431d-a5fe-49c0-80af-e5741c93c15e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "579421a5-3948-4610-bdfd-67a6ae332249", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c9f2db-748a-4f73-a468-d683a127b304", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d3fbe8-28e0-478f-b67e-f0269e7cafae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f543cf97-d6b8-41da-80aa-7b58e61f8141", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a229ccaa-96af-4da9-8a1c-8c03f81b99dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79a0f7d8-68c5-4c9c-9b9b-dc1c1bf4ff08", "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": "7f334c62-5586-4dbb-aefa-fa54fb09bb96", "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": "c3a367e8-514a-4954-bc6a-096854a4fd27", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f37e98ff-566b-4596-beea-7958ccaec604", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "552238d0-d4ff-424f-84db-674730d2959c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4266483a-0359-4f3c-a82f-4be45d46fe25", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ca36d8-8406-41dd-a60b-7f06dd34e517", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b22de2be-31d7-4f08-8487-52a5358fd6c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b9e8c2-9b23-420b-b719-b1ffaa0364a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccfabfa4-6d4c-400f-965d-da562644d7a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efb436be-f309-4224-a998-70b14d1ee372", "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": "1b91a40a-fef4-40a5-b187-092daf5c76f1", "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": "9d4ec260-46cb-4048-bea4-366d95e9836b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cd10d11-27a1-477c-8d74-a834f51bf59c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c740f80-b91e-4ffb-8762-1b9249b4b938", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f8b2a9f-7eb7-42a9-9fe7-c846a7b7f945", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4223e317-bf30-4c13-9602-c6f879191627", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be9fa9dd-39ec-48d1-a780-d0cf1a528057", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5536787c-9629-49ac-8e12-cc4036c249fb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688a00ac-572a-4219-a1d7-edf0c527b8ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cd8e67f-905c-4f07-87ac-79ce6838a25e", "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": "external_create_user", "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": "order_type", "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": "ba878c8e-ef80-409b-bb71-928897062932", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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": "4335f8e9-be4b-4ece-a907-10ab2412c1d1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d6a4963-80d5-41c9-92e2-0ee7517ce5e1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ffde19-905a-4575-b6b2-d2050fa93e9b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a734ee-ef53-44c4-aeac-1fc895e0acc1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d51e19c-c9d8-4b31-a443-654a06cb43fb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5cf031a-5837-41d4-ad1b-970f30fe7a2d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c5e45e8-9684-49b1-bc68-b38328884208", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "214060bb-2146-4dde-aa47-04a9dd85e615", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_update_time" }, { "key": "update_mask", "value": "external_create_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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4cdffd6-e3c7-444e-bb62-43ae1ed6196a", "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_create_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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "deee2afb-1e09-4830-a629-4e382e880509", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\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": "61ddba98-a9bf-425e-b57a-6219faa711d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b511581e-cb23-41d8-b85d-87d1f31ba09c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "161c52a0-4024-4ba8-99e1-fba99822d646", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ba6e88-4632-43be-88fd-5601085a06f1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9649b86c-7567-442d-8441-df307cfeb5a9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c21772-0e30-4592-ad5f-774c60897498", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1a8d28-16c9-40eb-9c58-60a3c4bdd360", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "198a78aa-e562-4925-905e-f972e8f6a6f1", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_source" } ], "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\": 5455.221141854249\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb5f0862-efa2-411a-9ab1-e9d69aeacbe5", "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": "ff535ef7-5e28-4953-862c-01a5142a1065", "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": "cf9d17c1-99a7-4da6-8b1e-d7692ee03b89", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "871f2ded-a888-4c51-a762-1f02e9ed87e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51926303-f16c-4dab-ad1b-4c6b4ec4b404", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bcc5de-e69c-4bcd-a19b-b209af60a3a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7a3a28d-3b47-430a-833e-0f4518e5efe3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbfc5c6b-439b-4b7f-8268-dc46c60b5738", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2316f6a0-fb75-45c7-9479-e4af85b5811c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc974b3c-7671-44be-941a-026de256dd7a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02495f2f-4290-4841-b1b5-d2ee8c8c42f9", "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": "03184929-663d-41e6-b5d2-171da80840f1", "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": "ac2b1b6c-2c3c-4c42-a91f-0f36513ad512", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1627543b-f576-4521-bd37-56741c6a0920", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a76c134-4571-44aa-8fa9-59df7458c3be", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907457ee-9bfa-4412-8cdc-6771312dad30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5a9bd12-1863-45cf-929a-c73faebbee04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "897e659c-3b95-473b-a3c2-e607066ec67b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84a87b2b-9711-489d-abae-9991adfe2c7e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b46a228-ad42-4ceb-a381-49a1eae626bd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90687748-adf0-43cc-bc84-f4a1651b9366", "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": "subscription_plan_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": "price_per_unit", "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": "5e8719b3-9590-46a3-b0b8-93fa6d472cd7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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": "111a2bfb-70de-4d40-bc94-a353a7eb2d60", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03f14274-c67c-418a-b346-49ad237b042f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d75168f0-78d3-4bc6-95fc-06b79fc74195", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9474003d-e1e1-4ad3-b51d-40c58ebbdfc4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e0ef07-939a-4662-aade-eaed185eece5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "136f3ba1-7b07-48e8-9d38-aa035c08a496", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b78cc9cd-4d7c-4093-be5d-7fbcfefcc34a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e43e40fc-b3cb-4f34-843f-dac20440021c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6d754e3-6ce2-4fd0-a480-2ad08e7cac56", "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": "50d0fd7b-0377-4a24-9f44-078c84400f11", "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": "bc0374c4-2a40-4745-ade2-1bddd5412c04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bfc8798-1130-443a-9009-621658ef13de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce98d41-e09b-4146-9116-0345529d42f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2df264fe-5937-4670-b6b5-990fa2ce7a0c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68afb1ad-640d-4f29-bb41-35c833ab6950", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9897d277-e898-4d22-ad3e-b0410f86b519", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f1b009-d6eb-4678-b258-41574b547a57", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d495af0-9944-4261-a8e7-3714f2498b26", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61463804-a26b-43eb-9f91-3a37d3ba8498", "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": "options", "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": "group_id", "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": "df86c4de-9860-4521-b798-b8be8426fd8b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "e1d0daa0-9916-47b3-8241-ec9fda1150bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02d170c9-dc6b-4236-986a-d0a8e54cc151", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a7a17c9-d1c4-48a2-934f-d5ffb5b64dcc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08e801ed-eff4-4a66-845a-0cc9f1d6d768", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27f4740-eb61-49e0-a962-2cd670a3e2fc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49520fb-751c-4915-ad9b-d7bec02843ef", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45fd981-224a-4a76-85ac-77c52b83b1e9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76dde349-8a14-4f69-b4c2-1ff7b76b0e19", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95a3d876-632e-4c85-996f-b6d649bed8d8", "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": "8a27a5a2-ea3a-43af-93e0-dc181d0e9d74", "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": "a1324e2b-7a90-422c-97bc-274fbc5cb6fc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e5e1c70-ddcd-4cea-82e4-583da1e54ddc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d11c167-f285-47f2-9d36-5b9937eabce6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959ab03e-5379-44db-8d48-68f4a1174147", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38815037-5246-4eb5-925d-50f3bc66b4ec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e81337e-0400-48c8-bea7-4be7560eb892", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60dd50f2-a7c8-42cf-ab50-d52421b5a412", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa734505-8816-4261-bcbb-911a41431b6b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5312e2e1-619a-4c5b-83f7-5e4bdfa7d610", "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": "1415b8f7-d4ec-4b11-b59a-49896fc72f6e", "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": "1616f45e-ee41-4007-8055-7bfae3c63ec0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c7818a6-17cb-4477-b374-d709a2c95568", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b02d866-52c3-437e-adca-ba343a0684f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b97605e-3edf-41dc-8232-7ce8fc3f9de1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ed14d4-bf08-41c2-9288-40c6553bc455", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1074a8e0-8662-4d16-8d24-313baba74f8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e953934d-1110-4290-811c-8ec20780b3c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b15c8bf-3054-4e13-92e8-e5e580335d1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b62573ec-465e-4329-80bf-479704dad1f7", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d604a248-0481-4f0c-8a99-ec3e2fa12e47", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "694ac58e-32e9-4fe8-ad58-2a153a853b6b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d04e845-1819-4253-822e-8166f069d103", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfdd32b2-67db-452d-a7d0-4bac3d0f11b6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa8e6be9-2d0e-45f6-b40a-a8087a3f37b3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1c9355-129c-4293-bff5-1c6e74811bc0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1595661b-f1f1-41be-9d79-89da71a9a747", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4c6c2eb-3943-49b4-a9fb-24b795c5d7cd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a398e17-1492-4360-9b59-dd38c2ac306b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec6ae050-2736-47b1-b21a-2a6fac0a32a8", "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": "ca82da44-ef27-4545-9d65-18f36d92c0c8", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e7e15ff-6842-4bad-abc9-2f0a89834c1e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6253a52-08b4-41ec-825b-ccfa8fd97d80", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce48c9a7-a93e-4bf6-93e7-a2eff4ebf111", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "525a815a-c3de-4712-813a-a46441181d39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db909cca-442b-4dc6-bc75-b6e7080feb02", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fce31a-d5cc-4606-a60a-2ab4f821c5a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73610a0f-189b-4171-9125-3a88dd4d3a8b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886b117b-676d-4512-8e0d-96f5a5b4533a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20fdb6ea-9994-408e-bd4f-08016dad17b2", "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": "9526f9ef-09c2-40e5-9401-e46b3d1e3af2", "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": "afef0656-90b4-4610-9a9a-b0551a4a8710", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d002abd4-2d9b-491b-80f3-d5700c3efe49", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "987c36cb-6c9d-4330-9f66-0c4ca485996c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64e3ed2a-6336-4f83-a5a7-d47cb067623d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc4bac31-4a6b-402a-8663-a3dd6436d99e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c5eeb06-6bf5-4edd-909e-3cb8eaf2cdfe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f10e5916-8987-456f-9ae9-b81c58330250", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b7830ec-2389-4e2c-98a9-e2c400904027", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e4c739b-92c6-4c7f-9166-fabfc04bc4a3", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8292fefe-4d59-40b6-bf48-495652bb758c", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9134a0c1-d545-405d-99e5-cb3a0245f388", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "239cff8e-46e4-4d30-ac50-0059e641ed17", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd112893-1b82-415d-9f97-03ad8e105c83", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b72c38e-9ae4-470c-99c2-5f084d7c0e8f", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc83ffd-53cb-4214-88d5-298e00b11a58", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad2a0283-1163-408a-af88-af53129645e0", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f239dda-20aa-4d49-a2cc-7c9871c09722", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8b69462-d21e-42f6-b5d5-a4dc4537e8b4", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3491046e-adb5-4f1a-ae62-667ca119978e", "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": "a1a45c61-a10b-4a07-bccd-cfd68264f35a", "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": "be24fe85-d53a-479b-92cd-4c8fca6436f3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54147035-3d4f-41a0-bf60-16d3416863d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04e3dd25-25b5-408f-a22b-d92cebeeb2db", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa0dce81-64a3-44c9-bf34-bbf96091fcf9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a86deb74-c106-4765-86eb-0424a22565f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074349e1-e679-42cf-8a7c-3759a3a5e5ec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "275bd8b5-e218-4fe3-b544-6d6db626b7b9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62cd0f25-8380-4e36-96f8-8790fc9d1a90", "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\": 7566,\n \"message\": \"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": "34121125-3675-43f7-9662-f6f747994d45", "name": "Payment Method Configs", "description": { "content": "Payment Method Configs endpoints.", "type": "text/plain" }, "item": [ { "id": "3a9d5879-4290-4a8d-9e5f-7b0a83d4b706", "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": "73146c07-a52a-409f-b9e4-3a165a778c73", "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": "a1458bf8-c80a-4003-b520-f4a385116658", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51a91e76-d109-4dfa-bf74-538793d471a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b87191fb-9602-46d5-b5a3-75b278912719", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1570151-fa76-45ae-9a4a-e07179009a67", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a329a97-914f-4a68-95de-2d4e3484af73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7f18a3c-f844-462b-bdb2-5095b2cd274b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a411f988-57e7-4728-b7ba-563a200202a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f60d048-608b-4a20-93b3-52b5891ef318", "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\": 7566,\n \"message\": \"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": "d1fc5731-bb40-4967-892d-db8c6871eb34", "name": "Payment Methods", "description": { "content": "Payment Methods endpoints.", "type": "text/plain" }, "item": [ { "id": "1af32b5a-7851-48c2-8ec9-073da4a49b92", "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": "3b0f3b0c-e1ab-4027-93b7-d1ac8381fb9c", "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": "411b3c1c-526a-4a77-8e19-ab02d4ffe28d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b1a938-373d-4ec9-8687-6b61a9c574cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f85676ac-d006-478d-bbce-a583729563e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "277b8b4a-97fe-4fb5-839e-5e2f62eacbe0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f190342-638c-4adf-99fb-99147cfdad29", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04ce00e9-4d64-443e-b08a-963a3012c17f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae2f9f28-1330-41ba-bb64-8b3a221622ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "371c7429-2dd6-4a2a-82fa-fc2ac57c2388", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b76d1ca-1887-44c2-b5e3-f98d5b16acb9", "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": "fcd25c7e-c729-4e46-9248-a68f9481e9b3", "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": "fdbc7ec5-5515-4176-898f-6e264015d57e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f6fb953-cf46-4ca5-98ac-913fec60fabc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e1f825d-2bb2-44b8-9929-08a68f420c04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be863af1-6186-4c96-b10e-c042ab652e12", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8fb1aea-2a36-415a-811d-cef43a5eb3fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "755e3191-1c71-4c62-984b-5df29ce99204", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40e8386e-8061-463c-86bd-d80835452261", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde24935-9733-4769-a5f2-be6774b9dc57", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d0a1f5a-8114-45ed-a2ff-72d0bf3ae628", "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": "1a6af1cb-027b-4616-8917-d1d3134ac327", "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": "c5312943-a2c3-4401-aad4-d7b98cc2432c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6aaa53d-f060-49a0-aa94-f3c4397d4f69", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3b1e675-bde4-4de3-abe3-ab03bdaaa780", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed1056c-39c7-4ecd-9eb3-f134363ad8a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee217d0a-6a73-4276-a9ec-5b50876ba8b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8957afb4-7c58-4888-a39e-40e742665ea8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2309337b-1750-4ae7-a472-3aeda3f3fce1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0946ecc-f5da-4578-b6cd-e79d4b8b31be", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a719117-04d0-4895-b322-984b3087ccde", "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": "43ac39c0-a15b-4fee-932d-70bc20ae01cf", "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": "b8acffb2-2ac4-457c-bfbf-e616ff057729", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241a92dd-8fd5-463d-8a7d-69b2d0a47f4f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b592b08-2559-4449-9189-38ec97305ba9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e737a163-5f9d-41f8-a1dc-c382e585152d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea5b39b9-672d-4251-8f52-b810d71395aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf48f359-741d-4f7e-bd40-54fb205801c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21f812f6-50d3-4be5-922a-f69e1abb27c6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfd0cdb0-341b-49fc-8039-8fe79c856249", "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\": 7566,\n \"message\": \"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": "e9d769e7-0c9e-413b-9d28-acf967959867", "name": "Product Categories", "description": { "content": "Product Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "9c006c2f-b5f3-4662-95b8-13430bff6fa0", "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": "2c156b8f-770d-402e-93cf-a724ae6cc15f", "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": "f4cf63db-bc60-4375-96fc-a74e99341010", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b221d8d-c3b5-4d89-8641-7860bc4442ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "375c75a2-83e7-44c7-9a72-ad10f6b3ff38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b28a96-ff53-4b89-afbe-6782e714402e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa72b9c-43e3-4ee3-a755-a69fec688ba9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b595a16-13c2-4fe3-8915-0d1dc9abe7fd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d412c7d-e31b-407f-a5da-fd1a3f0e0dfd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e36e12-a7da-4766-8a12-e22488608123", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53462fbf-4ce8-4db9-9211-16d252ca5990", "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": "e0d35f7f-d798-468f-8c06-bd34b0cbce36", "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": "50680d11-35ef-4a21-a938-78d33d744fff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9c20796-0649-48fd-9744-4af7a110d42e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a888ed3-4751-46e4-81cf-f92ba309196f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31bfc946-4c51-44d0-a110-a04d3480b229", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c802d70-33f9-4e2b-aca5-cf8193e7b283", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4e83578-b41b-449d-9c51-9d9224963050", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd4b8c5c-e51a-4ba7-86a3-4a42afba53b2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53156bbf-0758-484a-95c8-36aec145ac9d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4f56951-383c-43e7-a302-16b5868d5ad4", "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": "bbcfeb5e-42e7-4d04-9f5d-192aaa685b52", "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": "27cd9a96-553b-4380-b835-bb6ab2053a16", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2b11f01-b9a7-45bb-89ee-db1c4fbd0437", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83367693-e687-44fd-8435-75214da7d71e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0840e90-5be4-4088-8447-a288f585b313", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cebf2706-d762-4f7e-8abb-2cb7b4fffc6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f0e81ba-9efe-4d92-a90d-9a046460ec35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d249f9c0-a38b-4236-a21e-87bd823b52d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff977d5-df25-4108-90bf-e97eaffd5ed8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7ae74ee-a790-4228-867e-de3ec63e4387", "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": "5d53d1b0-57f0-4144-a82c-690bc9ec1d4a", "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": "1cd40b7a-e87d-45b5-baae-c604e129c305", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27775e88-55ae-4c24-84ea-9799f3c675b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddbe53e1-d631-4568-94df-243030c4728d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce75d4a4-d2eb-4c6f-a354-8a484dbbe286", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7548fd9-b7a3-41c6-9239-4016201ab34e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b90a49da-3714-4415-8537-9955a4348f6d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40b12dc7-dff1-4ade-b4f4-fe194eeaa74a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a71b3fa6-5195-4dde-8fd6-d82bd74fe2fe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be5bfc8e-2f71-4456-9f4d-dae3ec86ba48", "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": "d5598bed-67c1-46a3-b1cf-5593a88894f7", "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": "463da1fd-f22c-4a7f-bdf0-19140bd68d04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b61d9a-a72e-4d2f-b937-9482a589cb15", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5717a79-e676-4134-9863-e4ac94265a94", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "356efca9-3fc0-4afc-b34c-1236a56dde53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea48b842-9f4d-4e29-9178-1bebd228423a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72aa22c-7be6-470f-9f56-f2500e77977a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4c4324f-fb9a-4184-9cff-b47c40d30497", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7096540b-ad0e-4790-8271-bcda5e97320c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1134abc-474a-4244-b0b7-e02dcfa232fb", "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": "acbbaa13-e465-4445-ad39-6a2a82c1331c", "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": "ac909fcd-b400-4b33-bfde-ef2b6fe60a01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acd4153-0192-4b1a-8171-c083c873f47d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07e99e88-1b4e-4280-a644-8134ab53f488", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658a9468-23e9-4887-a002-eb558d58348d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d01a5aab-c12d-416b-bb1e-9d23c0c6757c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c143ab4-aec7-418e-a051-0c80bd9d578b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17634fda-19c0-4916-8fe8-503b1202fbd2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "675a0d2e-febe-4f89-842f-8d15be40aa05", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a814f223-40a0-4b7a-9b44-3ba0180101ee", "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": "1c974674-c292-4d2f-b22f-34baee4f1601", "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": "9d7e2130-f7c6-47d9-a09d-44ffce76ea5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4aee401-3802-4594-9fe8-8f917dd6c413", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12ac0b38-e4c9-435d-86cc-59d516e81358", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d96a49-2008-4805-9255-f6ec0bc8d36e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47951258-46d6-4d9f-8388-516951d9ade8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8039a971-f196-4523-ae6e-f522a80ee4dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a96148-a460-44b7-93e5-d3476be97597", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d0aefd-cd4f-4aad-b884-c12a44dbf857", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9baa0090-20c5-4656-800f-7225f245b97e", "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": "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." }, { "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." } ], "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": "2a744293-7717-4942-b474-a41295986292", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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": "33b04aa1-64be-45ba-9540-498dfc538df4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c539574a-227d-4a1f-8c2d-d9eaeaa5fc40", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c15769-18c1-4c3c-99c3-9e8ad12eeb77", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24da6099-ef85-42b8-9d0f-f64d48001d6c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e65a5f-c20b-4df3-952a-269f4c59d1f2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27a20bd5-6c80-4ce1-9f54-d92acaeebeda", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ac2675-d1fe-4e9c-a2be-b36066b2041f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ba17ff8-0360-4eef-a255-d1f420b76999", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9c97d10-4a4c-45ef-b561-2d95ec4c61b6", "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": "be4b63f1-f2d5-4efe-9c3e-43f5c7693c52", "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": "d2173e3c-c7f2-41c1-827f-cfb82e7bbb4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bec5237-24c5-41e4-985f-82bb646602cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "164437d3-b448-4c2e-88a5-fbff83e4b967", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc7cb76-a01b-4810-8a92-e271e903c6af", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcea9341-6832-4408-9a4a-6797014a9bd3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fab1a28-cdff-4e83-8772-a5b46a6f7e01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "319a4a4a-7946-4e3f-a70a-3e708c21834e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0622f089-c761-407e-90ff-3948e6dbebc4", "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\": 7566,\n \"message\": \"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": "fdaa1091-655f-455e-ae73-98c8aa3adbad", "name": "Product Discounts", "description": { "content": "Product Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "c73fe101-8374-4aa5-b872-7895d4d57dea", "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": "f2b4fabf-a6eb-4f64-9e11-794bc0c99919", "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": "a8636d27-bc83-44c7-8814-4bd5bb4b38a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c851b2-febd-4c95-bd00-493324d0f2c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d3570b-a172-4a0a-a51e-7112536abb78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e4a811-40f4-429b-ba50-bafb66e9026e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20580ba4-3794-426e-82b5-54ee20bc5a9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5dbd688-91c5-4828-b127-5a24d1dc5e3e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20df77a7-72e0-4107-9d71-784445856e61", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "953501aa-d628-4bf7-9477-1677d36e295b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72cb25ad-0515-460c-91cb-9f8d61148d92", "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": "d0a6bbbc-dbc3-45fa-b7b7-5dabc77e80f0", "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": "52fe5b30-ff60-4d3b-89e7-35638abe410c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07173339-575b-4b7f-8cc6-cab80d07924d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb7e1ed-7d0f-48c2-8766-de8e995824a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7131957-05b3-427f-bfde-db1c4e80af22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a388b0-f997-4610-ad2c-11b4e839ac09", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4313142-af1b-4d0e-b1e8-b38d4db32ea7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddd6bbb9-0cd8-41bc-a2e2-9622c081e777", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc0cdf2c-9c0a-494a-bdd6-b470c8bc81cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07cbca3d-f58c-4a14-910b-c672a30b086c", "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": "d710583a-8558-4e78-bd31-50da07774591", "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": "e9c26c19-5029-4ed7-b3bd-b10af0d96126", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fad5be0-9b7b-425f-941f-d90d3c94bbd5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "075a4ba5-8c6e-44b7-8f8a-bfe0c48783ee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4a9dc5-a1b3-4ff6-b6c4-b6893906634f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a829526e-7268-4563-a045-0bde33432648", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787fbd13-f9b0-4135-b884-483cdd2cd3b9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24542f7-a446-4c68-8df2-fdf0df54b747", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1839e2b-8b76-4c05-8611-855c71d7ae19", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d3782ac-110c-4c42-90d3-e177daae4474", "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": "b85707b5-834c-44c9-a982-62847c8da4c2", "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": "864eef7b-6af0-4b74-aba3-45c83ea9ce5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa270f7-0acc-40a0-8cf9-575beca89a2e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53581660-0781-4844-8b75-310883e11352", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6efefb3-1bd7-46a3-ba19-549d951f8215", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61c9c4b2-7562-4c4e-b06d-5cd84e38024d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bef66b8-2a69-4526-bfec-8107e4f17408", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac214643-a178-40da-9d0f-88f9e700f8b9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a96b447-8ac0-4a95-821a-cfbde9f9262e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88b8813e-c659-424d-b713-56ae0f65f678", "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": "87f5dae1-6d5c-447d-bdaf-d522e376f6b6", "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": "8d80ba39-ed42-41ec-84b7-deb835352ea4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "676ae2c6-f07b-434e-b300-470df9ce1d71", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0293bb8b-5c7d-415f-828f-82f911d9c8e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14cf34f7-ddbe-4316-8d22-e1a21bf4dfa4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe7e9c9-7b28-47c7-82f1-2ad9c15d5998", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8efd4eb0-b6a0-4f48-a719-36d6f5e17ba6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a081e81f-f2ab-44ad-89a9-573fb18f2d98", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976653b8-8c42-4486-8bce-fd85d10845b6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61715d6e-ac3a-43eb-a637-3f5b4fb0d54f", "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": "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": "product_id", "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": "371c3abb-57cf-4050-8ac8-5722b98fdd69", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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": "9922d95e-ae08-4431-bed5-d61ab1299c17", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b64b2997-d7d0-4ee8-82f8-2d622ae27686", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96680b86-a63e-4ff1-a5a8-6a38939872a6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7775970-f89c-4c0f-9320-b488087bda30", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdee6503-dc74-42c8-89f5-c2d8c78d6c34", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c8722c-b522-4f0c-a2d1-167b95a230a0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e907d8d-c936-4ee5-9e2c-6fd000e0c366", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "120b3b93-90b9-413c-83fb-b3e5863e39b3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e180055-e99b-47d6-8695-45183057723b", "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": "4fbc6b0e-7f85-4632-90fc-c24ccea85c28", "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": "b4e7c547-74b3-4ffc-a822-4dd9dda3c789", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b255e118-2f5d-4e40-8863-20fd47254470", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a7c9c8a-c5fd-4a6e-af0c-0c70bc4ade5a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f3846fd-813a-4cf2-bccd-0c081af3b33d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08f08e8a-94c3-449f-a3f9-83be60591da9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b0ccd2-4d25-4752-8935-4e3966d63b9e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8627f066-5602-4d9d-8be1-b52363cca584", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9f01f3e-ffe0-4719-822d-85f816555853", "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\": 7566,\n \"message\": \"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": "61593f14-7c08-46ce-a184-ca27825bc043", "name": "Product Interest Bundles", "description": { "content": "Product Interest Bundles endpoints.", "type": "text/plain" }, "item": [ { "id": "f36faa8b-aff1-45d3-83a9-60c8e73ad4cb", "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": "6eedeea6-36c5-4643-b450-9ee9c94fd9e9", "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": "8079d8ec-7622-4083-9e26-800c55b4d146", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a371c9c-3417-4d3c-9d4d-f34521705fce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88b379f1-330d-47cc-8093-1568c00261ad", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93659ff-aba1-411e-94d8-420c4c1fee52", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53004714-552f-46af-b15c-eac37f5c942c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38313760-352f-4349-82be-9ab110212e04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e09143cf-3fe7-477e-af11-f86c8f27f005", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01b4129-d6cf-4c7f-985e-99c60924e88b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a752f79f-1d9c-4168-a520-4fc2d3aa399b", "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": "ca053654-dd78-4f1a-9849-3d7709e79487", "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": "120ac05b-f318-4f53-af55-d8d0a303b084", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b7be5f4-9967-4a98-8abd-a21cdca6779e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11eebb39-4ace-41d9-ab9c-bf0bc7ba94d7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68897fca-560f-4923-a691-0f7fb7ceb52d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b72356d-06bd-4f9a-a62f-eb408e298590", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb08763-9116-4671-8dc9-bd9c48fcb561", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44a751eb-9d59-4720-8c82-914a84df8269", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e413f798-9c13-4a69-898d-4b0ebd3c9fb9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de9d7bc0-2b2f-4e60-98d7-d49e286201ba", "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": "a7c96bd3-b5be-481d-ae9c-0d10292f3a4b", "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": "41631c94-3f78-42a5-a4f8-bf50b5c99f84", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa1224ad-f89d-47f7-8de6-0d9c8afa6d13", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b9e036e-6230-4a55-9588-b6e9b9e66268", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95a1f579-773b-467d-93f6-f59a8638b524", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e8a3c40-d343-45da-8614-694586aae422", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "817d033d-1f4d-4507-9cd8-75acf37152d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc962ea5-4db8-4443-b7c6-61771dd74178", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c19377e-86c8-4b99-abc8-1ea9c02c15ef", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3e5b38e-539f-4e0c-842a-9c4c2ba1e7a1", "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": "f5c25a89-fe5a-485f-a9da-4cd7ae98e30a", "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": "b773abbc-8f33-4e7a-91c6-665920f48d22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b18f9b8-9f5a-48d7-bb63-4078133415e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2252da5a-db0b-43a6-a59b-9151f24494e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f814cb96-950e-49e4-83a0-d6d1a6addc3d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8887b55e-3f0a-468e-bdf3-8dacae03e1cd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8f5b260-b72a-43f3-a04d-309d222e67e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6267c89f-0627-4fce-9e2b-586a8b6e27dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04854738-9d04-4ace-a919-36c30606c90f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bb5ca8f-6ca7-4320-81cc-0e04115e62b5", "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": "7e9a5f90-9714-41e5-bd1e-71048f9f8e96", "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": "6a72ce8d-7bf4-41fc-9ef3-f79d5b1e2eab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59052aeb-660a-42ac-9352-0e23fb1c4ee4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "867cc349-c126-4a1b-8e25-35a83680d982", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453c6441-6051-46a5-8344-76e13acc27e9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5184ec74-50a9-4b61-9fd1-13703cbb0f59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01cd90aa-b8df-4aca-a78d-e91757afc042", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c44d82-f5f1-4f05-9c83-482662c05550", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3d1c177-6707-4f63-b3b7-66fa96507003", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "defe0174-1bff-4652-9f80-dc9a87127ce3", "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": "db03063f-3408-49ae-9b7e-60cb1d2505f3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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": "19f550cc-f60a-4ca8-9208-6619abc43c1c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af19b59-37aa-4e1b-a3bc-ec08414a4d44", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1ff77b1-6dac-4c1e-b0f0-5eda1497085e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6184721b-1adc-43a3-af9d-d3c45c2e791d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b76ee858-5470-4311-851d-834bc089032c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efbd55e-ede3-48fd-b738-c5bab108a1d5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "459eeb92-7099-4942-8b2e-2b53e963de0f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d8f51b3-6988-4c79-b4a1-fe1ef9ce2cf4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "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 \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e667d29-3d87-4a38-b560-06bc07f3c3ed", "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": "5ba45693-4efd-41e0-817e-9ccbd3e24297", "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": "f957d61c-c29a-4767-b919-453e036905ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d4251f-2647-4025-8d32-2c539677860e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a37307-d444-44fd-8f2f-bf847ba949d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86631da9-1355-4c98-b2e7-30f21552c193", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa52a9f0-492a-41b7-bd06-8b1169fb0352", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280270f2-cf05-46e9-80f3-46dc481dc9e9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41892dea-94f2-484e-85f6-3b5a96fa5153", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f23b84f2-95b2-4aca-8691-7cc67a0f254e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc09e732-fa3d-4fdd-9bf6-331f446d580e", "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": "quantity", "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": "a546549d-7c3b-465e-ad9c-85a290969cac", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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": "4f2b1753-f67f-4f10-9ada-fe55899d5075", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3cba3fe-34a7-435d-8c67-f20e1f4aef19", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24f558d0-6a34-458b-a34e-efdadb1df4ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa1759f5-57bd-4910-b7e5-8821f6dd52f7", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dd48011-2840-45c8-8f5d-e7150c155525", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0c5f140-4c10-40aa-8bd8-372a0c861ba1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1681c17-6fa4-4375-9eaf-a64d423c1069", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dda7744-0118-49c2-8d29-b86ba3238ec4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "quantity" } ], "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\": 7566,\n \"message\": \"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": "9d1a3e1b-ab13-4f55-8783-cd38c5fdf29b", "name": "Products", "description": { "content": "Products endpoints.", "type": "text/plain" }, "item": [ { "id": "76c30b4c-9d72-4949-890e-cd1443fba8c1", "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": "571abcfa-17c3-4f18-84bd-5b02b47ed8dd", "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": "8573858e-07cd-4e35-bf64-54deb3c97027", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb1b302f-726a-4806-af90-33b9636e4e88", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b00751fd-d0a4-4105-b098-39d92ba75dee", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e40d15f-4339-4a04-8453-9e571cc937e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3df9c53-62d3-4743-9666-74c3950dd2dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e1e7dd4-8626-4382-a332-62acb6325049", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9645dcd0-136a-474d-8f3a-9ff3a78e8359", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a1de55-77e5-4977-9a11-7a2238515609", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "675e9d0b-bfda-478d-9f74-d4cb7aa4adbd", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c7f15bb4-746c-46b2-9f60-72171aed1cb0", "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\": false,\n \"needs_digital_delivery\": false,\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": "262cfbff-989d-46fd-a5bb-6699d6ca46e3", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d3b95fe-966e-4efb-bde7-e3d4055eafce", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f56760c3-1e8b-417b-9281-625a611b99f2", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17871a64-3b1f-4798-9bac-8cfc10dfe810", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0967118-1999-4a50-8302-5b06a11e64b3", "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\": false,\n \"needs_digital_delivery\": false,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b5348aa-cf1b-45fe-bffc-ef78c0e5ebc9", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c8efda-d892-4317-a2a6-fce7338251bd", "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\": false,\n \"needs_digital_delivery\": false,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9965659c-d223-4e00-8a3d-a5187d9762cc", "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15221043-7431-49f6-a6d8-cbf59b1e16fa", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e7bcf868-7050-4af4-a8ec-a840ceaf432c", "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\": \"INCREASE\",\n \"quantity\": 9969\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": "f0eb59d7-d446-4c6f-9b73-dd030465067e", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f13bb84-9e25-4d09-b67b-f3fbac8a92b5", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25611288-aee5-4f17-97bd-45959e80d5d2", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f5135fa-fec6-415c-a882-79c8018f7343", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8ee7529-1aa9-4e27-b415-82a57d5b8446", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cf90253-60cd-42a5-b591-d46564bbbfaf", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8af3ebb-95c0-4894-9c50-f43b183794d2", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1579231-bc1d-47c1-a5f3-333fa881a911", "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\": \"INCREASE\",\n \"quantity\": 9969\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5adfc20-7b28-413f-968f-0488822ae6f6", "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": "a548677a-edaa-43f2-a44c-ca45f22d1973", "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": "ab1ff17c-9090-4875-add9-3e0681e13320", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad6dbd29-7c72-45c9-a43c-ecda1e9efdba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422a80d1-d56e-48a3-8784-c818a721ff98", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eebb91c0-5563-4de6-a475-740af9e769a7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "843b454b-f963-421c-9b1b-5a8e1a1177f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af4faffc-7727-4ccc-81e8-4be2ba4a0abe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6638eb0-4904-4bc1-aa1c-7b95ff3f7ebb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c67e4aa6-7e0a-4c62-9194-6069df9a8e07", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91e0a5ba-ee56-47f8-9daa-7ce40cb3d077", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 5250,\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": "9dc35930-3076-43eb-bc56-e3678f44b04f", "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\": 8657,\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\": \"TEXT\",\n \"display_order\": 509,\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": "0c848bd7-b0d2-41c0-8c1c-341e418282fb", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7121fcfc-1ee0-43b2-a075-5c8431c6203a", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50f5f021-eb57-43d9-9090-c071d2725a6f", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00eea708-d32d-4ead-bea1-8e8e73216c2a", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e7c9113-9c88-4021-a98b-97130a517ad4", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150ef9e2-473f-4ec3-b493-4cc6a406474d", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90793a64-5e87-4a22-b206-e850a92ebd0d", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "325eb2a4-ed48-4d77-9d17-fff597e4ab3a", "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\": 8657,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b13f992e-c2e4-4e72-87cb-b53ebff0f4a7", "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": "c1c04684-ff8c-42ce-b64d-61bd539769ba", "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\": \"TEXT\",\n \"display_order\": 509,\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": "2156cb6d-179e-4ac5-a89f-c30f3a3de7a4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6fdee6a-9988-4da1-9096-f6350469a7b2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453a1587-21cf-434e-8b18-82d49895f627", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12267795-9cab-4722-b42d-d777ef6b9600", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cbd5a29-0d57-4d52-961a-2ebe8dec4cdb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37075b03-ac5d-4219-b9c5-28c7f5863a15", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc7d75f-b055-484a-aec3-5aefd755d7d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a2b5fca-0af2-4ad2-ae5f-db758d62f687", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e67f6ab-34e4-4a57-9051-0cff7ee85df8", "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": "0446d8c5-eb9b-487f-b7ea-c768ce4d8985", "name": "Created", "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": "" } ], "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": "05717ccf-d5f5-4311-9831-b0f3acacc200", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3119c7-9059-45ab-aca0-4938d30ce63d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a72a557-dae9-4b46-9b0c-27cc2fe71b9c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51cc2f74-0250-482b-b480-17a45707d34f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fa876b-03e5-42c8-843c-5f598afd1d8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac1e6a9b-34b1-46b7-80f9-f67fa0ac1b63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ef5a6f-151e-4890-8265-d8162081b323", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0ece9f9-4eae-4d6f-810c-4c32a9c61330", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3050950e-8e89-4a3d-ba7f-8f53f89f53e2", "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": "483b886f-30a8-4995-bf0c-5d7908390001", "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": "ccb21811-d294-465c-beab-0724d7ff3b46", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa7260f6-d76b-4bbe-aa90-7841e04740d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be7f3d42-1e1f-425d-8156-01ead1933e66", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3a024a4-7aa3-4f14-9b38-f57584d56968", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84c241fd-9813-4ec7-a7c2-403c4f1fda0b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4444357d-684c-4e14-a3ad-e496fb919e87", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64fc9726-8623-49f3-9721-3726e8ab0f76", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71379781-7a43-4788-8716-a63e9ff3d3cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f487cda-09fd-403e-a178-e7af207144d6", "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": "b3f508a4-dfd0-41d5-9766-51f5abba02e5", "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": "11b56dd9-7c5b-4cea-85a1-7379ba0ce507", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b3bedd7-fb6c-4700-ac6a-d26cd0eed8c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d88ca57-4bb8-4afc-b429-a03ab0c0114e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50beab26-a041-4032-8e5b-3dda00dcd987", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a12de73-b654-4a97-a575-4a471a070fdb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e2376df-46b7-45a1-961e-07b4319f5981", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b2d4c7-0dde-44b6-9be9-ef59a2452b36", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bcc679d-5f96-4652-9caf-e24cc8c86e65", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b7bcb73-c26a-4d22-81ef-82e5c7d3664f", "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": "6450cb38-d26d-427b-90cf-7d53e46cfc73", "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": "a5072fff-9d47-4551-99e1-975a82982026", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb09f3e3-89fb-4731-8bb8-92f02a641b94", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ae721c-bcb3-4f66-b6da-6ba93b58daab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2db65d20-9e04-4d3f-b6b4-d10205afbe1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd423cf-3c03-4bb4-ad68-34b6c183ae4b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622690f3-257b-48fd-aafd-f54ee7f76c8e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "845caa19-8e60-4caa-bc17-baffe6ae8b9f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "706d8e51-cde6-48aa-a656-5437f597c4d7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e030523-302b-4ce6-8921-733e3fde9850", "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": "inventory_limit", "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": "country_taxable", "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e86b5255-83dc-46ca-a1cd-a34d52843426", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\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": "34200210-0b82-4518-8d4c-cb6cd2c0b4df", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954636cc-45d3-4ab1-b0c5-6f0985df179f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52cebba-97ac-41d0-a1f1-f33367e30ac7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a59078a-9f14-498c-b3a5-3634b73007e4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca684d82-a514-4728-a85a-2fa7af6b0278", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eaf8533-7760-462c-a9b0-b35ec13f3414", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43a628fe-db68-46e1-8c23-439d56a4d187", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5103463e-dbf0-4fd4-8ca7-264822cd4298", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_only" }, { "key": "update_mask", "value": "active" } ], "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\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05a2afe9-897b-43cc-949a-356de0aa5d54", "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": "fa069413-d0a6-4fb4-be94-d6f8a078a8c8", "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\": \"TEXT\",\n \"display_order\": 509,\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": "79a2625f-c8c1-4665-9921-e22171c2e064", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ed9d1bf-5cbb-4961-a9f1-afa86e3dad1d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a7ec68d-f749-4cb9-b1a7-6b41c2078d0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aae46099-bf33-4060-9e5e-b5a752c9cf78", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f002097-0c4b-4ecc-b924-269a09d98716", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6edaac3e-d05b-400e-b236-7e06c140130e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c9735e8-29c3-487c-955c-6f2e4e090a5e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c0975e-c4f0-430e-8f8a-482a24c0d188", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d374468-caa2-4af3-b24d-e9b33d1c7081", "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": "1c815712-8b0b-4a36-bec5-22c9b403f5dc", "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": "7a7b830c-99df-48f1-8e19-436da36b3108", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39eb9b5-9199-4fa1-baf5-7170dee660ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a486788f-1b3a-4e74-ace1-b80c4dbef0bc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0987f5b6-8e7f-4547-8d49-c04f9311cb57", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15373ec5-80dc-48d7-8935-d8eb0d645289", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35575ff2-90d4-4573-8b70-a890e4110600", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1261741-d7d8-4939-9f19-f308aecc8071", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc6ce8d6-0448-41eb-a34a-c0a91e825396", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f3e63a8-6b09-42b8-a3ac-edde968242ed", "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": "required", "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": "only_starts_with", "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b3e3570-3f67-4aee-afcd-e9382e7f6684", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": \"TEXT\",\n \"display_order\": 509,\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": "a8ec6fff-4282-409a-9a8d-b3d194992f05", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd00ae2-0288-4fa3-9735-b871b79999a1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da3f4631-3b0b-40bb-a77a-31ee0802a3ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c64e570-cd49-4cbf-9aaa-5eb3b456af87", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49dbd9e-6d48-4aaf-ba07-47d91b0d44ac", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4bf7ac3-b3cb-4b41-a840-0375f6b5399b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a4cfdbc-b052-40c3-9425-43584fe09a1b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "106dbbd1-9efe-4e77-9bbc-f6879570c3ad", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "only_ends_with" }, { "key": "update_mask", "value": "maximum_characters" } ], "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\": 2281,\n \"minimum_characters\": 9256,\n \"maximum_characters\": 5719,\n \"allow_spaces\": true,\n \"only_starts_with\": \"NONE\",\n \"only_ends_with\": \"DIGIT\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c70d13e1-fa43-4d58-8744-489f235cb7dd", "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": "2423576f-c585-4c34-8f35-a587d51656f1", "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": "62dd615b-60cf-4b37-85dd-95f1ea2b42d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e3f086f-5a07-4a62-a254-39b2767127da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "734779ae-01de-4acb-acda-efd99bf4047e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9969a4c-800e-4bba-8979-6b635ad29d3d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2113f7b1-8840-4cc5-a6cc-645f4eb2573f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fdf901d-797c-458c-8c96-b296d6a9e3b0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a46973f9-d5a7-4669-adb6-7b32c63c1ea5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f2e1696-7a7f-4a00-9a72-e9b1c4c06ed8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d048d828-5a2a-4d19-86d2-e670912848a4", "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_display_order", "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7f286476-3306-40f2-ae0b-9b95e952182e", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\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\": \"TEXT\",\n \"display_order\": 509,\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": "c3786147-b6b9-4e2c-b6ce-4bd7f378f755", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155f2888-f812-46f3-aa15-4ce7a2d6f79c", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5bb5af6-e351-4c9c-a157-12ac78a4c9c9", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48edbb6c-cef6-4ab4-8ef7-211da1f59541", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec79cf75-b907-4d0a-a452-c70bf76a634a", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb5dfd1-29e9-49f8-a590-bfac43d624da", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28dcb937-3d4b-4293-ae85-c55e2ca4dc7a", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c1483e-ab02-467b-99b2-1c29f4a580ac", "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_code" }, { "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\": 388,\n \"price_adjustment\": 7040.49236252758\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dc913a6-2b73-43c2-9e10-237ea51a112d", "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": "73eac73e-12a2-4e14-a346-3c43c62e83cc", "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": "a5690e8f-6995-40c0-9e4a-8bf78a17f2ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781a79cc-6958-4c3b-8ad7-6f74f91f6a5f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0315e1ec-2e43-4f9e-a488-7908102bc939", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2a66e5e-fcc7-449b-b953-3c9d728f0708", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "548ac098-ee0e-4262-b0dc-f3ee05ef9b3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3577a29-f88b-4d7c-b03b-962856c1cce2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7317a549-dc75-496b-8537-6d83370dd25b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c795c62-6ece-4986-b8da-93e2d00c17e4", "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\": 7566,\n \"message\": \"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": "f02cfda8-e7ab-4f39-b175-5140e4b7c601", "name": "Referral", "description": { "content": "Referral endpoints.", "type": "text/plain" }, "item": [ { "id": "86c52c37-ae88-42cd-9ed8-800011422474", "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": "8c12a3e2-978d-4321-b3b3-c57b17965ffe", "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": "29a6b57e-9503-4eba-9d63-4e290f74d3a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f619a3e-6acf-4019-87d9-0185770518cb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb35de0-7fdc-4fab-aa83-891a356e3bac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93c1153-00be-4baf-8a6b-2510a9ac1ace", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8c681e7-e9df-45db-9d37-73ac39a38002", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7449675e-f85c-4d5c-9163-6fa78d215b30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fac447b-0848-46ba-9c77-09d0145e3f2d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c12ec99-e7e9-4e02-b50d-6e6702028c45", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94cdbbfe-170d-4c19-86ee-52c1654b3006", "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": "e037df05-af71-4940-9cd1-718afb5dbde0", "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": "d8f18d95-0759-4e9e-b50c-a47a79e77e39", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58333dc-25b5-42f3-9975-8dddb0732637", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827b25d4-8e0d-4f72-9e63-7d4692042694", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af43707c-a0f0-445c-9341-51aebb3590c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf19cb9-39e6-499d-9c68-a3aaac40bdbe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a9d7e46-3374-4c8c-aae4-f68aaf2576d5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8489605-43d4-4b95-bd26-44d7f67f2e12", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09d54448-abd5-4d1f-ab45-47f99a91fc6e", "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\": 7566,\n \"message\": \"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": "2ed58992-304d-4ba9-ac8a-4e14afe875b9", "name": "Reporting", "description": { "content": "Reporting endpoints.", "type": "text/plain" }, "item": [ { "id": "3de6477a-13b1-434a-9a0c-95c2c4ef32e6", "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": "4270", "description": "(Required) " }, { "disabled": false, "key": "fields", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "781d815b-9666-4a14-8618-33287bbb0959", "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": "4270" }, { "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": "53f86f8e-03a1-4b4c-8e5f-c53cd89269e1", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9772b334-6301-4ff6-8692-913ccf7ffbcf", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "284946e0-5fc9-428d-9875-764e02ada4a0", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "993addcb-c60f-476f-955a-d93bdd7b6fcd", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2dd9c7-90a8-44a9-85bc-4fb3984d8041", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34728d6a-10fb-4b64-a2eb-ea6bb18814bb", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b90e7b37-b451-4268-ba77-0ee5d043635e", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c6b6323-3a9a-4e96-b4f1-d94bfb1a4773", "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": "4270" }, { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d8cd4bb-1bc2-40fd-bf80-67b7b738fca1", "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": "0e769b79-1717-47c9-9dd7-0958869e97ef", "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": "06b8a73f-6740-47b1-847f-0c3a55164e62", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99307093-5684-4546-b1c8-f0586b9e69e1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f407e07-e98b-458b-95d5-776cdeaf3907", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eef2e6c5-982d-4282-85e6-ba960f169e9f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "523ad2f5-c0ed-4caf-b6f9-54bc65c8fb0d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caa3bb2b-fd57-49b3-bbb4-3ad0b6fcce33", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53aede7-d992-4193-b37e-001cdc3d01d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "115138dc-c9d4-42a1-ac3e-3935cfff2b36", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4a8e748-3546-4e4a-8f70-b58a3b6f3f5e", "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": "570ced6a-56aa-4df4-a516-1c7e3c539adb", "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": "0643462d-ec79-41b8-91ab-7368d52623a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396b75a3-d626-44d6-b46c-5609bc8c6ec6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73ddc07f-026c-45bf-a6fa-bb6be8347c63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "306a5060-fc63-4fed-97cb-12b156c4f9cc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee106924-118e-41ea-86ff-7c538f400b30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77bb2805-6d4d-4f1e-88e0-b0fa99b53e58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8419683-3ac3-4754-a136-0f6c691cec70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f69cd6d3-eeb7-4da0-a1b3-adfba54f550a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b77b093-b19e-4823-b9b9-10e52dc4ab0d", "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": "cce40c95-9911-44d3-ad0b-762a3678512c", "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": "ea2fcafc-c128-4264-9b92-d6313b229424", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67325557-bfff-4bcb-b4d1-031c052e4ace", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a18af2c6-1689-4468-999c-84060588022b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "010f9a31-3f00-47f5-9cc3-6e59a079873b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e0da1ab-989e-421b-b396-0db99135359f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c82b7e3-7c65-4ccc-8971-d5be7c909df6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59934373-fbe0-43df-a900-e9bde6da5f27", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3d69ea-a8d7-4576-901f-485178dddc0f", "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\": 7566,\n \"message\": \"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": "bec37585-cf5c-47be-9cce-a286b46fdacd", "name": "Sales", "description": { "content": "Sales endpoints.", "type": "text/plain" }, "item": [ { "id": "d7473bcd-5e72-430c-9394-a51c41bbb051", "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": "2b6108a3-2411-454d-8b9e-405f95afe438", "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": "492d2472-e2be-440b-a278-9eb9bde3e8a5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b154b33-99ab-4942-a377-b3dede69078f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55745c76-0ca1-4d2e-8a4a-eb67fa56719b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25c5976f-0835-4e53-bf04-6487a9599b79", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30bb051c-a544-4528-b5c8-056f29ebe610", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "753c3427-c06f-450e-af17-50f8bca449c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396043b7-52d4-4fd1-838d-141c5f216248", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9fbf2f3-9d0a-4d67-8522-d2d4fa31e48b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "043da007-ad56-427d-bb87-841cf7e780af", "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": "2de3688c-b453-4ae3-b7e2-cf2443f8c7fc", "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": "4a28840b-743d-483d-9d31-1b59a75bfe1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4b88753-ba24-4ae4-b6ad-7d4635414764", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "921d50f1-a085-4365-9c6c-91e2b217da46", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a47b4560-6326-46a9-8e39-00bfc5f72e08", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c26bdc3d-0abd-4cdb-b2c7-839cd661cec4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92961e83-5525-4b3c-9fe9-835d6a02873c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e37e800f-8545-45e1-8804-f477d5b0d453", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35bac469-897b-4b2d-9ad5-a48f3479a7af", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71af14e3-25e8-4a3a-82bb-fdc6e7a6e503", "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": "52076888-3219-4dcf-be60-98bb94869337", "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": "06fefdd1-7866-42a0-9787-565cda91a857", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ccef9a-6554-48be-8fba-f83580070a31", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b85fef-3c06-4a6d-8f34-638845bf529f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de12230d-7425-4483-9813-20362f19bdac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f3f95a0-a43b-4fac-9e2c-6f9033504a3f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3103760-afb5-4b39-b765-71683f953dcf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a33ed22-8028-49a1-a552-b9c658678794", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0035c1ac-3009-4b7b-a2f5-5c3cf55dc486", "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\": 7566,\n \"message\": \"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": "ae94fc26-5caf-4a6a-96cc-7f069de03c3f", "name": "Settings", "description": { "content": "Settings endpoints.", "type": "text/plain" }, "item": [ { "id": "58c54291-0fe5-420e-950a-66a8b4200fe1", "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": "88ff38de-0cd1-419f-a196-9cc28d84d4b7", "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": "ccd7f7ae-97ce-48c5-b66a-a0db6d42428e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46e69bb0-7352-43ff-bf95-2f7c479cbf50", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "680ad212-310c-4d67-9e1f-188d62480fb3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69dd7d9c-7b0a-4336-ada1-5737d97b6e3a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd95a621-6561-4319-812f-dd61f2f73cb4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e5c9ea1-87bd-4c4e-934c-bfed6a38ddf5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "009d99bd-9294-4168-ac03-0138aab87a80", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5d732ab-b203-4969-84d5-3b00ea8abe5f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f7831c0-5e07-4885-a6a1-cd8ecccf2927", "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": "32f9743a-c82d-4cdc-8122-7193f10f74a5", "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": "933427c5-6d5e-4f28-8f39-0ac1fdd2e108", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c40d0bd-b849-4539-8470-168a37bcf612", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "063bf042-6f7b-43f6-a5d8-a7029a686588", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564920a0-fc2b-49ee-8bdd-5687f0f055cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5a3a9a-9839-4844-8e9b-9ecaf9d1b5b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf151b0-b9f5-4465-b329-e2e54ca7587c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72d81fa-6f1d-4124-8b77-c6cff43cdf0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "982117ed-8542-461c-bfb1-483eaffbf2da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19b02fa0-2b33-49da-9845-8ef3fa09690d", "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": "TASK", "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": "CONTACT", "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": "009158b5-83bf-4ec4-b515-ddbee44f036b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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": "cf395d03-2e91-4fbf-9520-c11e674203ec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbecc1a-f4ba-485c-92f3-850ee13d6751", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a057c8c1-8761-4e3c-bf88-504553e4b735", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "075d60eb-9467-4a92-8b89-69ed591d79bc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65803fe3-ffc4-41e3-898a-f624f72625d1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "674fcca9-2481-4b87-9d51-3dca105695e3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e504312a-3f0e-4489-bea8-1e5a024f3bc9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0bee3b9-f51f-44ea-afbc-d6640053cf0f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "OPPORTUNITY" }, { "key": "fields", "value": "NOTE" } ], "variable": [] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"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": "81baf82c-97fd-4412-9098-392b137ae3ca", "name": "Shipping", "description": { "content": "Shipping endpoints.", "type": "text/plain" }, "item": [ { "id": "40ae718f-aa69-4df8-9e5a-c5fea6f3f8e7", "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": "2c722e20-d6d9-465b-b181-63118c87c35e", "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": "768f6b6a-19ff-46f7-a8a4-ed359580a8d7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "729ae682-f4cd-4c38-a550-61de7109a93e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f6d725-1293-4840-a9c4-f1e073186959", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "365975ec-9921-40fe-b899-f6c5aafddc5b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a003b47-7582-4e6a-abfc-e44c3d717a38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a094911b-0869-4f4d-9748-041f193df3de", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0796cb-f424-4500-bca2-b35765b98d19", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eca7521-1e91-43e9-bcef-c5354b61db4c", "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\": 7566,\n \"message\": \"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": "cacae9ba-165f-4349-a0e3-fd516e91b57d", "name": "Shipping Discounts", "description": { "content": "Shipping Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "afaed66d-7e99-4b9e-a26c-9c4e473c53dc", "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": "eefa776f-9b24-4423-a3e7-307d819bb23d", "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": "7d7b682e-2089-4a45-a930-808765765646", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a35517b-1ba6-4bec-9445-7ad22269e85b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ef06f93-51cf-40d1-850a-81ec64ae24d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1df89e98-3619-4a65-9570-ad9b3fe29ea2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23f0f4d-07c2-43c4-8793-eaa78a6ac261", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9dcc2b-ca12-4d9e-9a5d-fad41fd416f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c49787aa-5925-4df6-b5f2-623cdd82af1c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7104cb1-e9cc-4354-9357-39f85574639d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0cce23b0-5927-4e7a-adcf-ac4305f102e7", "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": "f2f97352-6496-4857-a80a-14c172ef7386", "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": "986b980c-c5e9-4465-a375-f95c4d686b77", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "858a680d-4c53-4333-b531-39cab16accfe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59034e40-8196-4186-8fbe-45fb3d77e982", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b2bb2dc-9e45-47ba-ac1d-02654d60e313", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e630204-38f5-4ba8-a388-a886fa4330e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66ebaf9e-5a19-48dc-9f5b-9edb14b47ad1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f399570-cd7d-4eac-b69d-1788a542e211", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e70c1cb1-6578-41b9-93c6-5908b8283601", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "009385f8-042d-4cca-8b34-a6400f12a499", "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": "22f25d82-fcd7-4123-a783-e99ea1a3615a", "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": "6d666ba1-347c-49f6-afd5-04ea2355d7c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb0c163-9760-4fd0-bf2c-c7d1c9456b53", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3d66ecf-aaa4-481a-8ae1-c75c6be0d833", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21784bcc-8c5c-4df9-91f4-835f2bf5a640", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed4e8d44-e7a6-430c-9fd7-2b6f7c131de6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3bd4ca4-96e5-4bde-923a-38642bf3336d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcedd913-be09-47bc-93ac-8c013b445733", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d8805e-5641-44d9-99b8-bef12f83428d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "593f4181-ec7b-4708-98f9-6dbcc263280a", "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": "e16040b4-8c91-44db-ba10-ab6de63a64f1", "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": "55fe344d-7f7e-4d5b-b249-e88a22253e06", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b87957-f45e-430f-b8ad-028f269b0370", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10e5781b-496a-4140-9140-f201fc1423c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d225a5db-4995-4ba2-a281-20c458ed0837", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af035d5b-04da-4763-bc7c-3a608e379e4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2cd441-bd32-4905-80b2-e92f837c2944", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d36a565c-0dd9-436e-a001-1498274200b9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c84abf78-d406-42b7-9b5a-211278dd375a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09f7964f-d0e2-4342-8cbf-48f8fb9f1510", "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": "1340005b-9ac6-4c2e-b678-369f5225c129", "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": "59c14157-7919-4285-a641-79c6ee66e167", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c54c1e09-e693-4453-b8ab-f239685b3aed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b040eb7-377b-43cb-b9b7-a5ed6b3dd7f7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a86c0460-af7e-42aa-8b21-87e49df6ddbf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6bf8342-ad09-46da-9f35-a095c2153447", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b83fff-a41c-44cf-bee9-311d1b3766d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d17ed5e-bed4-477e-9b33-d7181ac63f81", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfad4a8-7513-426f-8f69-461e73e4399f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "240dd201-3f53-4fc8-b31e-24bcb9201515", "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": "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": "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": "bc6a6800-e7f0-40a9-8911-09b7e748061c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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": "2cba0656-b425-414c-891b-e05be63f7dbb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c892f2-c088-4f22-b9a1-2262ea2fa5a1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7138c712-219b-49c2-b4d5-bf038888357c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1895ca91-22bc-447b-9ad4-b1cea72c1ab6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef53d4bb-984f-4011-ad02-c54df13b729e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ec644a0-a506-4e12-9bda-7315fffd574a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d88d6da5-9fb9-400c-915b-def1f616fde4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab01cc26-1634-4a0c-96bd-1dd03842e480", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": \"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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f7e9382-e4c4-4358-8c70-db5efc5d2e5d", "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": "73cead53-0abf-4e06-adb4-cf0fbef0ce5a", "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": "47a7de35-c03f-4443-ab90-b1863dd5435f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "353e3875-5257-4350-babc-d34c9c6f94a8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ee0b6b-8543-48cd-9043-14f30e01f798", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db71b020-40c9-47ab-9561-64824942a201", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38a11e05-b570-4507-9590-420c8476c0af", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9abdc83a-49c4-46bb-b185-d1140bbf269c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12fa90f5-8bbc-40b1-b05a-045346eaece7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04363716-654d-43ae-9a3f-269ed0581fbb", "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\": 7566,\n \"message\": \"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": "91fc6201-eb6d-4c52-be5b-afcc88d0547e", "name": "Subscription Plans", "description": { "content": "Subscription Plans endpoints.", "type": "text/plain" }, "item": [ { "id": "2f53723f-4291-43b2-a9a5-b5357100a30a", "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": "4377567f-c148-4915-9202-7bde0910726c", "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": "a34563bd-ce4a-48c0-ad12-7b0210f7a5d2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f276a1fd-caf9-4cf4-a045-a33307244e00", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "926f5327-8e0e-4851-b700-bb3399a19914", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f260f33-9d2d-4e85-8782-757b9755bb31", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05602490-641f-45a2-9206-3b1e5d1b6164", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac84136-94f1-463d-a3fa-98f4bf7a1d04", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bffdd3e-f498-4353-9146-9e9b5db80e9e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c08f2cdd-82b0-4c8e-bdf3-f6cdf5e7a4da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "718c9b4f-188e-49d6-b8fc-adfadd8adb9e", "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": "e5ec7d03-fb7c-4f6a-8cba-d51040116d8e", "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": "c663eb8d-ca58-4538-b0a9-02c8b32fd9ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5659aba-9cdb-4372-a86a-b5dccc39fe29", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1590a4f-68f7-45bf-a8b3-a2b56edff91f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8fb5380-858b-43be-995c-51797958d2c8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21be4bbc-730a-481e-bc3b-326f67517358", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62fbd30-d0bc-49a4-9eee-e759a3399c24", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976d81bb-04d8-4dce-931a-474f76d1e7b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0785ec50-e01e-4cb9-a5f9-e978b07f7007", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62a07c22-b50f-4c2d-b667-2d0d2faf49df", "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": "88692420-7230-4356-be3f-71ff35a4e601", "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": "5484a1e9-183c-410c-8050-dbcffae9d0ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ca9b267-def9-44c7-86f4-7da110d3c230", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0216dc25-5660-4030-841b-8907510814a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4875e2-b94a-4a56-a39e-bdc6220d5020", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "467e9ccb-8f29-4d8a-9541-5d33c2ad6180", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6538640f-d2be-4eac-980c-a33478beeb86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69e528f-e3bd-4326-bffd-be6d04f35d86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea9340f-f9af-4c67-9a0f-f6047901d1ce", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15d36464-9a8b-4142-aecf-c65ce09daf55", "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": "f7dbe487-591e-4a7d-9623-ca87142c028f", "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": "5e7b7398-b372-4cc0-ae9c-59ce902f0587", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9c2d15d-078d-41e7-88c1-c2a08fd48368", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ce9d1a-93a7-48a0-9536-2005ec6e9d18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc131049-bf85-409a-bfcf-8bcc5efc45e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2795528b-ea39-4ec2-a667-66c80035fbd3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f885fc2-3c76-493f-8688-7a44e186cfa4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7635a98c-0ca6-4dac-b11a-58472af6298c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c29eddd5-8054-419b-aa24-e3a6d6e91e1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58ee60b7-2e6d-4b9d-8fbb-75b6ad2d7308", "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": "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." }, { "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." } ], "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": "9aa27715-64f0-4446-b837-b0e531596721", "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": "65a4ccf3-e6f5-4de3-8e1b-329d33085548", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8658c75d-9da4-48d1-b03d-d22c7e20d978", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c93d88-c58d-4424-9c5f-b98e69b515f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb2e6773-9e5d-4e80-9d7b-287bbdd836ae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db67a517-4a78-4f90-a78c-df802b32ec72", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b0624ac-8d00-496c-88f4-8b10093650b9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53159810-474a-44ae-9b0b-dd5997718845", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f37d361-4a2d-472d-8229-07c32c33cd86", "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\": 7566,\n \"message\": \"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": "ae83c612-8119-49f1-980c-9abf8f867656", "name": "Subscriptions", "description": { "content": "Subscriptions endpoints.", "type": "text/plain" }, "item": [ { "id": "97b01940-0255-4750-a6a3-26687bc8d029", "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": "65746465-1a70-415d-9ff5-8e61602e04a9", "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": "5885676d-bdcb-46e8-a629-d53918680d3d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241d14e4-3145-4c30-b4f4-4e122899984f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63fae348-cbfa-451a-a2f5-519e3de1aa5d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e1df87-9e05-4231-bb48-f535468201f5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93550d1e-7b84-427e-9a48-e083585a0ac6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f20c3a2-6668-4120-8076-b80ca94cfe97", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0795406-3706-4ddf-a0b6-6c89bbf98460", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "198c42f9-82f2-4a33-bfaf-eb3c1e98ba7c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e8d2a99-13de-4b31-bdc9-544b60d62a68", "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": "6c53ec98-9da8-47eb-bd3d-deda05cd68d4", "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": "21f4046e-353d-46fb-9e68-05ee7d7fb6a6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3880b17b-a906-4064-82d2-da7323d0981c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34b00631-4f83-4c3e-a840-27eb45cf0a18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54054ab6-df5e-4fd9-9c1d-f400e518aaae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "161c74c6-9b69-47f6-ae82-238b719536b2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11993c3-59ab-43b6-ac4f-7cf57a293f5f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e62b4d90-2707-4f09-b506-34fc5c816042", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "307f8960-496b-4542-b3dc-6769fccd6448", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d043381f-b266-45a9-ac8d-3a9ceb56ee4a", "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": "99bd351f-59f1-422d-bb75-40c6e68e9a54", "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": "6a7b2fbd-fef5-4c24-8a3f-342761a337b4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c9d87e-78a1-4e6d-a04a-0b0095a28717", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb436ce-e6e3-463d-86e1-ef77ff74792e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a18883e-fb5f-442d-8d8d-f9dedeeabad4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db323ba0-3346-48ab-8dba-8ccbb877b041", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84dc94b-55ca-4a7b-a230-4c00e8e5068c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b05bda56-2597-4992-9445-dd4d8d3f27e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01088f67-84d1-4e21-b4fa-823998827e4c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "823f21d0-5aba-455b-a67e-30f379fd64ff", "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": "a140a6fd-4b48-4515-8262-523b3ea2eb86", "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": "c4d65f10-0dfa-4c9a-8515-2ef1691d58c7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b99b371c-ab91-4359-adb9-4e1e464e2f4d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbf11f9-d26e-480c-9add-ea59f72a6271", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c1565f8-0e46-4b5b-9431-2e578fbb48c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06bb9c3a-b16c-4a06-afda-5b9ff35c06c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d06be44a-db00-4eae-a3a9-07cb60b21a12", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac043857-c0ff-46c0-8d6b-12342f3fa056", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8051656d-0913-4e50-b942-bf54408b1240", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34b86d7c-7765-4bab-8603-3d04de281c3e", "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\": \"WHOLE_NUMBER\",\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": "fdae3daa-0c4e-4af4-9521-192a1a3f42a9", "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\": \"MONTH\",\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\": \"COMPANY\",\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": "b1b02e8c-0e5f-412a-8083-11f96d97c6ed", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be12b508-89c9-40cb-962e-1ec9b046cb88", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9af5675d-1fd3-46bc-907f-28440714c40c", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be559d3-8cad-4ac7-96de-44312310b64c", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb1c75a5-789b-434f-a729-8590d602b220", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "302c0fb4-5561-44b9-ace9-dc06699cec15", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29de05b6-d26c-4bb2-8706-2f0e42b92f84", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e587fc04-46ae-4e87-ae92-64aa26c2ceed", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "550cbf96-e26d-49fd-992a-71c20ea85c17", "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": "2c8d97bb-9ade-4dc7-9151-efc4e1a0aa81", "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": "cb4d2cad-ef7f-450d-ba3e-436a77bf2a69", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb32c92-6fe4-4689-bbb3-1d65a02dd072", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d70e703d-7dc4-405f-a104-ebf88dcbcc23", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e91d5daa-9166-414f-adc1-78306634625d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb0f6339-69cc-414a-974c-92c80dcc5a6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cffe5a1c-cd44-4a00-8a92-432841a23879", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ccbd60-5551-4466-a004-16db3dbecd65", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f3881f-9c37-41cb-a0bd-672f7cbd4a34", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da756a3c-811c-46e5-87ea-f19742ef5622", "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": "9c3fa791-9057-4e1b-a548-0b97c2c9113d", "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": "8a9052a8-535b-4822-a59f-3718ef989b28", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97fc971c-c811-47b2-aa06-495da4988272", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f34a4a-af97-4c3e-8ed9-da7f3ac2b611", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06682544-59ec-46b9-a221-cef377a6076d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d23025-e00d-42b2-8436-f9f260007e4f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f31af1-701a-4931-aa70-1b5975971b25", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cad91824-d5c6-4958-8ebe-21aa44643276", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "732c3010-b16c-41dc-821a-3e95c7cdf3e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9a3bb4e-d855-46ac-b239-9c5b2bf1c207", "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": "cbf900c5-1a61-4e49-94f0-e155bb0d97f6", "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": "86d35784-ae42-416a-9e51-ba4f785934cf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d010967-48e6-48ae-bc65-ed39c22d1bfa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64b7933e-e9a9-42b9-ac40-9aa020d6cced", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0366c0-a091-4bb1-9c9d-f904b0a691ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "427c4db5-ebb9-43b9-8169-cd5b6befc457", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3a8e90-d927-454f-aef3-a499a23936f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd8e77c-8b53-4149-9185-a5c554052558", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d311e07-d04e-4706-83bc-f4bfe59996f8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47bdc735-8349-4b6c-b345-e8c3438046b6", "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": "7846356c-2a93-49b5-bd12-7071214abe04", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061fffc1-c3a7-459e-9982-5750c01bf545", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "350ab4e5-75c1-4c4f-b0a8-5700dfd8bdbb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede84863-c24d-4846-b8bc-a2fbb6b70564", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d8bc067-731b-4895-8e3d-ddba3899e0ac", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99a62881-8bdc-4691-8c7c-ed6dd255824d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001f607e-6b5a-4c9c-b068-28ee1dd42419", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7813914e-c460-41fa-9ede-e3f1443b4c21", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bba503f-b261-41fb-98e4-eac78a4ed660", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "228d1dc9-ded7-45d4-bd76-d4e118e450a1", "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": "0c645a41-a218-4d1e-ad91-b985abad597f", "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": "c90e7774-054d-452e-aef8-948ab2d2472f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb583095-9857-4df7-8ce3-f098f1992a3d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1b148e-71b0-43e3-8f34-17415cb97c7a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9772032f-ee09-4238-a21d-a09610bec1df", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b078f9c-1040-4d20-b0b6-fc2ff551aad6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b9c2724-8cb6-4221-bb5d-31b3c837eef1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59e9b1ca-ecc7-405f-90ef-ecf60d8c7c83", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65c7e88-3af6-4ddb-945f-b0f8be5f724d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b4afc4f-274e-46e2-ae11-8028ddcd7d3f", "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": "contact_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": "billing_amount", "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": "21013a45-4c2f-4a98-a7d9-b06617e5bfe3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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": "e7440ee0-9897-4bdd-a007-8bd4f074b5ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8da69af4-df52-4e4d-8127-88076663f908", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2676adff-8c63-496c-9ddc-e5261781a394", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e250f9e-90e1-4497-8906-188060fc661d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f302199-cb81-4b16-9bec-dc8427d00d70", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cec4c7e-ca9f-446f-a318-ac1604d30ff6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29db6cc1-a347-4219-9cd4-eab0b2743c3a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abdf8153-5e71-4084-b2e5-2c3b01cf7dd9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "next_bill_date" }, { "key": "update_mask", "value": "auto_charge" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6358c7ae-1992-4f97-a248-579f9b134b3f", "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": "e6bfe65f-f324-4091-974e-547d50c47130", "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": "90ed5797-28c5-4b0c-a64c-300c15b23b70", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f3c4b38-f7c6-4973-a5e4-29b4c158155c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "795527c1-3db7-4b34-bb0a-d24cd58e9145", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "157ad6bb-dd92-464f-b75e-e30ef4265aae", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "981ca206-3dde-4eb5-b338-44e990a560d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af197054-d4d1-48ac-b2f6-046e0e158936", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd0e7de0-ce6c-4355-82b2-be0bc58fca06", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4d953d-0640-4184-915d-07a6886b71d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5ab2e71-36d5-43e4-85fd-99a799471142", "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": "options", "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": "group_id", "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": "c9b53574-b4d8-48ab-b538-7f9cc08b278b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "a424b457-d477-480b-8742-c0f4f6c29eef", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "969f917f-c247-4f74-b603-5f60e74cf755", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2851231e-eef0-4edb-8c90-5db9ae11109e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9abc40f-e36b-4270-a92d-9d9fcdb950a1", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "729727ce-e088-4770-b733-2674acd2439f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8647482d-d208-4308-9f65-c1a25360399a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "334e20a4-90c1-4ba9-a369-7e9c768ced91", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462822a0-5d94-4bb1-b51b-eed3146669fc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6115ccad-67a8-4e8e-9ea9-1ccaab1c3c43", "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": "dc0da8dd-30ac-44c9-9cdc-b78b89abcbf6", "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": "636055df-abed-4a3c-9aaa-34848cec4167", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef4baf4-5fcf-4bf5-9b26-01c520a0d0a7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5aafeb6-c7e3-4fa4-944f-f4c452d8b036", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1a0bc3f-099e-4ece-8fde-58d1f8d9b2a9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7752b01f-cd64-4cad-8298-a3a1dde00c62", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a567ec-3f3d-45dd-bba9-c5d013985b63", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e774ce-b0e8-478b-902d-83b2f427bd6e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bc3d355-511d-4801-8b8c-22683d44bd6c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba7fe46d-b0d3-498e-b766-77a7b09ea10d", "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": "2dc5f70b-a682-442d-bf6d-168736ff6e36", "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": "3aedc343-7c09-4dca-921b-af7b092f89fc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8309893b-6e94-433c-b0fb-673baa2de34d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581ee2cd-7925-46f8-95a3-c7a5fba87193", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d00e12f6-fd00-4f00-9350-d2f40003f3dd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e588bbd-c76f-41fe-82da-07c49833c8a7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76d74cb5-b387-4414-a5c0-a173d6689da2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d37244a6-7264-4c8b-9963-aa670f0bc2c0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83cce110-62ea-4821-b38e-d064e4029ca6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84025d7f-3c1d-4a6e-b954-1019d3c36cc9", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7b1a5ad8-2005-411b-a85a-41640d6fbc3f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "809beee0-9ca5-48f1-8e0a-a785760992ce", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58722d2c-6241-4c50-b45c-90783e2ef492", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "346abd2b-d0ae-4504-8f0e-7b985a8e2399", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c1e3208-e354-449e-8948-bda2e7a1dc1a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13ae2d8d-c978-44bb-989f-70ae64fdaf7a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "646cd024-ee96-4ac7-9a69-205c1e3b1e81", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bafe7f7-57cd-4c27-8a3b-6c5bee836ea5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d85de29-a9d4-411e-b850-594d01b7fae2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c2baade-c5f8-4ca6-ae39-bfa61c210a05", "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": "f7ba5373-7b88-4ffe-8e6d-b1489690f410", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956718f6-5f82-40df-a80b-528a671ee09d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e75d25-30d6-4aaf-b68c-221ed07973d0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d7650d0-b679-4c49-8930-3caec4ca0684", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee3f57a-8018-4620-a510-420fd87c6d2a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "934ca905-58ec-4714-a0d8-93913dbda6eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e760b717-cc12-496e-aac7-5989a118dc75", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17694019-bdb4-4917-9dd8-7b6c4810dba1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f5e7484-895e-4eb9-91ce-58f6142ced86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8315995c-edd5-441c-8ae9-4e17361bbdd4", "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": "5b5080c3-35cb-416e-9fbd-01a588b71491", "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": "ffeb723f-a998-4792-b840-6008bdde9595", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c69dde0d-d3d4-4ba8-954e-b1626537a6e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35310cd4-31eb-406a-a4ca-86ff976acd7b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3755a600-7d59-43b7-b5aa-0f1878a52520", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14a6c0ef-9e45-4030-969d-22ced4d34625", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "706e07a6-05db-46db-9edf-64af38421c9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21e1a90b-ed81-4dd7-a3d3-f0ff10c345a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea3e78ad-1a43-467f-a567-b5c6a9923bda", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f2ff3b4-f657-4c72-997a-58c861b613c4", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "544ea47b-c440-4d7d-bfad-1a920a8f274b", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ecfc062-8a74-4ff2-bdd6-d2c088b2c35b", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a2f7fb-d48b-48e9-8ce9-4099a2869b44", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a43642e2-9e7f-4244-93fc-8492be911f0e", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54dda585-1540-4abd-89d7-19c98615e961", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce56999-f726-4563-b133-908c1c70ea78", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15ed1e17-9dce-4b90-be8d-fc09226b549b", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a877109-4197-413e-8c6f-ba6134d7bd1e", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b59126-9280-4114-a3e8-6945a8145066", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f3b660b-8b8e-4e4c-840b-59d98d2a944d", "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": "3fb75d24-d6a4-4c01-9199-42165302618c", "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": "02d6e1ce-c7e8-4940-bf61-58d96e2c5285", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a98c0d-dc71-43d2-8c74-a6e94684552c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b1cf89-7244-4095-b51e-2c5128f0b1dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bda0c8d5-46db-480c-893a-07e6f3236d89", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c85bfb-0dcb-429a-8499-399bd720c40e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05fec8e4-3aec-45c9-ba62-993047c0c5e3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629706b2-37f9-43c8-9e78-02c12e7e8de0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76b7bb33-6632-4dd4-8fde-55d5b02f5cdf", "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\": 7566,\n \"message\": \"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": "3d3edccc-d69b-468e-8866-0d9d957bd643", "name": "Tags", "description": { "content": "Tags endpoints.", "type": "text/plain" }, "item": [ { "id": "51cb2ab2-a02f-4b4b-826a-521893c600f9", "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": "a59de85d-167f-4ce2-9d6e-eb233848af69", "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": "2dd8fa2d-f220-43ac-a11c-d1adb4c56fd9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "273cee0c-d356-4f84-b503-3bda7158bd9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa2f5fa-41ff-4ce3-9101-5d8265874572", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "812e1dc5-c256-4b60-974a-2edeacf47e0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0fcbfcc-2089-4d1c-93ca-7c53e6faea79", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe5ee7de-3bb5-43bc-9a08-5eb0badf26e6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aaaae66-0fc7-4ba1-af2f-aedba86f1c07", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3aa0f25-e438-4262-bc75-d1d2443b7bfc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a730e16-ed5a-455c-b637-159dfdd1a0b4", "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": "0343d562-ec15-4e91-ac1b-5560da84d681", "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": "72124665-874b-44cb-a9aa-009e22bfaf38", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768272be-9ad8-46f9-b305-c5b37a89df3c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da14e28-075a-47b1-bcf4-8240e5cd9ea7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392628a8-efd3-4e4c-b28b-9db23ce22742", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1747dcc7-2203-4047-a62e-06c2433c9c61", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ad5f2bb-5cf1-4e9c-8b40-3099206350f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72853293-c859-4c24-b069-e3b2906563f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea62a51c-aced-4e8d-b4da-f8b8f6c96b66", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0bd70fe-948d-4720-99b5-67f6abce1f5e", "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": "9f514bf3-31df-46c4-bb00-bd3328baf5e8", "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": "8f99ec3b-9491-4d17-8864-68b222db24d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd560fe9-dc9d-4c5a-a54b-934b9dd4a5e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "555f8d5f-99c9-463d-8281-f3795ce8f859", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1278abc7-cae3-463f-80dd-25790436281d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b54008c-ee07-4039-9f78-684d2361958d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc1abea4-34cc-41fa-89e1-0882321f98c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf64a14e-1475-4e79-9945-a44ff69ef6c5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1261978c-5589-4118-99a9-60f083697d5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6199731-06ec-4531-85ca-524b0b8d47e9", "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": "e535bcdf-b19a-4b61-a27b-7005dcc9b601", "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 \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd92dc2-5e13-479b-8f93-8378c3279412", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d39acf28-642d-436f-b780-498ce72d466d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bff5b9f0-1d37-4eb7-a2fd-67c59729a260", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ca8f93-39dd-43f8-a8e2-605cc9b4412a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60780583-f267-45ef-9c28-b9508439369c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f6bb1e-3a38-4b61-adb1-7d8c0eb20b4f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e4a60db-8d8f-459b-a5d5-b265a4585700", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "370cc7a4-7885-4bf5-95a6-2248b2eed185", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7590f478-82a1-4392-a352-4100ad525744", "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": "5b6d67e9-9f54-4279-9738-b5aaf7fc52b5", "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": "6f313f56-63ea-4ba9-ac0b-f4f316e73c35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18e20f7d-2476-470b-a3bb-eae0fb33f95b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667e183d-251b-4bb3-b74e-72d1888b236a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29ddc849-5310-4de4-a0ec-64b788b366f0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1f9194c-8c81-492f-9b3f-6fe4f137b9d3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0720b4d9-a722-4821-9002-71c7e91bf960", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "024d2127-be90-4d94-b7a5-d6ac1fa03584", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b8203d1-e2cc-4568-9d54-074d9aad1bc4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3949c6e-654f-4c12-9863-0a31e41292de", "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": "fe1cd786-38d4-42cb-a91d-c2bb9eb242e7", "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": "641a07ce-9058-4557-9a2c-bb4418f41393", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d44d386-90f2-4725-97dd-29fc7568ddcb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ccadb49-f608-4f32-af38-bdced6e3c207", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2a253d-7c29-48b1-9bc0-bb4b2ef9db59", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a64214-7240-4d62-ba97-10a240c0ebea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7e78c3-dc07-4363-8c5e-3d2270f3df47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80894675-86f9-4cda-bfea-10acf5fe4bed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fe4a217-d00b-4a13-94df-f287dcfb88f4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92291239-43e7-4527-bcbe-74832c5c1f77", "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": "67e3cf4e-b619-44c6-b3a8-01d560be2ed5", "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": "d01281c5-c2dc-4a2c-b0b5-702b31ccc18d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f65b3e22-6c2a-448f-aedd-94930e5825e2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bc36814-ba32-4b5c-8cfb-d643d6ec99a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19bd6290-1cd7-4e86-a629-670da061ac0f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3519fe44-0d4a-4332-8aa9-15bea38a5533", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5093f306-651e-4d5d-a776-c66cf56232fe", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7792f4c6-73da-4198-a3dc-291fb4fbc5e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edd9ccc3-45aa-48d5-878f-76dc119ba3ff", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f60be67b-98d5-4c1e-9797-8b39f04ddfbf", "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": "eaa4967c-e960-4a1f-a6ec-f5bc50213e3e", "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": "fd44b741-1b22-4637-84bf-53095b7c685f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c7097d-22d7-4390-a021-2299e2e51a31", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c84ef2bc-5a26-488c-9173-7b03413aa543", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b83b247-39c3-4221-94f4-d993d6343bdd", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22a8a8cb-10fa-4837-b3a9-b5842c48f2c4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462ed6f4-402b-4a86-af48-964f660b7dd7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6526fcbf-7a73-4746-aa4c-168c1782146b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b2691d4-f927-4536-bd33-1061c240fca9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "463028df-949d-4e17-8fb6-6a3b74a4c31e", "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": "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": "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": "168af69b-9d46-4914-aa0e-0bec8b5d120e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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": "bf704507-c022-4494-ae80-c032407e8da1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2325e93-179b-4310-9c40-bae386c10b1b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e95abd72-ae46-4ab0-a287-5ceca77c39fd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ce35b7-4050-406d-b59c-ff1cbe046137", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd180f26-6c09-4da8-b59b-95b20a3fdf21", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b04c08-e771-4269-a586-509a2f55448c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564551fb-9224-4a13-967f-694da7a3f8d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f2d19c0-d478-4254-b7b7-0ac823c94942", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc860ff0-4a25-4a90-947d-609c9a850410", "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": "e480e830-5b29-4b4f-a2ef-9633279ab2ac", "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": "dbcae99b-28fe-4187-84c5-15e7cccc82a3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec63b23-36b7-464c-9872-3468730a8b25", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f54c2486-fa0a-4ace-ab63-8e88b9202b6b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e2829a3-e5f3-4b5e-8b08-5050d95fa6c1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50d47464-de47-48bd-bdf5-be36bdfe69e7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1ac2ad9-18db-4003-ab43-841cec0b96c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37830251-c9d1-4c28-b785-213dcd0c93b1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4301fb57-448c-47a7-9755-bdc61af0a424", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "542ff8c8-b01d-4955-9c8b-5c87889ea3d5", "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": "92bba98f-60d4-4323-864d-f0ffe0509812", "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": "29542169-c6f7-4120-a25f-10bb45b0123b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a7489f0-8cb2-48c5-b335-faa171e0927e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b071b67-db61-4421-919f-d10467b0d402", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcd938a7-7584-4844-9f0c-942193564ce6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bdd9408-29a2-4316-bda7-ce455ca4cc86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90809969-89ba-43d8-bb3c-55323f414a48", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7da8516f-6de1-4b51-b5ec-d8b7fc73b3db", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5da0711-5b09-4ed1-ab1c-a9e855714d8f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1695fcf2-ce92-44cf-92d4-65cb8a5ad811", "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": "511e8017-c33b-4c9f-ab46-ee3a6b3606d9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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": "0635d7ba-d41b-43b3-b670-4ad138f48ff0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5024311a-5c67-4e36-a162-461f7d3ff7a1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1c472f-2446-4196-ba1d-bfa64f579e50", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3736694a-3150-48d8-94c6-59aedf73b212", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8db5669-f4d9-4874-ac63-e0d522061e8b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d713db90-d24a-4de2-80b7-7ae2890422de", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b608360b-89d1-453b-bab5-4782ca922718", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396aab65-42aa-4e6f-afb1-23dfe82056ef", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9e70034-ddd8-4d3c-b7e7-fb2a0a27925f", "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": "7bfdbe6d-cf70-4a2c-8592-c234c5dfce28", "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": "ebbd4c90-d475-46a5-a1d3-14563ef53249", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce8bb46d-e714-4e33-8f3c-e2b7ea818ae2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ad5386-47b4-4dfd-ac07-43f6b762cb82", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "968ba652-844d-48dc-90f0-e1fd5cf36681", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac1d020e-319f-467a-a000-580c2cf8b553", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef403a12-546d-45c2-a9f7-db7c8ac2e896", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c6f3c79-32d2-4db6-8d80-0d367c21e4b0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada0618e-dab4-44c6-8420-47ba824aaf18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e583dd79-901d-4271-a568-1d7966de6f35", "name": "Tag Contact Count", "request": { "name": "Tag Contact Count", "description": { "content": "Returns the total number of contacts associated with the given tag.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "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\nOmit the filter to count every contact associated with the tag." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d1bd09b7-30d2-4d51-b970-b6e283ee30c6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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 \"count\": 12500\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdae553c-6013-48bf-b11a-7378e813c2af", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc6e576d-c5d7-4f7c-bf20-68252a9c7347", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46c7641-2008-414b-8617-0ff4d387e7e2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05ed3d82-6d8f-426f-a309-d7951e4801a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28dee0e5-8eee-4c71-92d9-38a89f795931", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2eb9374-b4d0-473b-aff7-c16f5987bf8a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6cf57e5-d345-40a8-a1c9-c02e88186a59", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a31e6084-b0ad-4652-8f2e-bb5839930100", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts", "count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) The ID of the tag whose contacts are counted" } ] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84989d96-6018-4f4f-9119-949859eeaed7", "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": "57e79f22-2963-4f42-8fbf-66816586dc7f", "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": "5424a00f-aac7-4d02-bc31-bbc6b50bc52a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "097d30c6-eec3-4884-b6f6-7d1d124e73db", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ec9a25b-f316-45a9-add2-560caafc65d4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eadd2a4-66dd-418a-97b3-70b9a32fcf34", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac1078f-84fa-44a3-8d8b-b85edf01db92", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28b87234-0cf6-4f64-8c5c-1d93ee80d535", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a5085f9-7225-4ccc-8b07-c9023c0d322b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc40044-5e69-4b33-928d-a2fbdbb69710", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc9c4be2-6fb6-4d6f-8dbd-03570989c982", "name": "List Tag's Contacts", "request": { "name": "List Tag's Contacts", "description": { "content": "Bulk-retrieves tag-contact associations across multiple tags in a single request. Use the `-` wildcard in place of a single tag id and pass the tag IDs in the `filter`.\n\nReturns lightweight association tuples (`contact_id`, `tag_id`, `applied_at`) — not full contact or tag entities. Results are cursor-paginated via `page_token`.\n\n**Filters** (`filter=key==value`, semicolon-separated; `tag_ids` is required):\n- `tag_ids` — **required**; comma-separated tag IDs, max 100 (e.g. `tag_ids==101,102,103`)\n- `since_applied_time` — optional; ISO-8601 datetime; associations applied at/after this time\n- `until_applied_time` — optional; ISO-8601 datetime; associations applied at/before this time\n\nResults are scoped to the contacts the caller is permitted to see. Example: `GET /rest/v2/tags/-/contacts?filter=tag_ids==101,102;since_applied_time==2024-06-01T00:00:00Z`", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply (at least one is required). Allowed fields:\n- (List[String]) `tag_ids` (max 100)\n- (ISO-8601) `since_applied_time`\n- (ISO-8601) `until_applied_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 (best-effort for cross-collection reads).\nField:\n- `applied_time`\n\nDirection:\n- `asc`\n- `desc`\n\nField and direction are space-separated, e.g. `applied_time 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": "21516b95-f357-4da0-9d9d-95bad62e7e94", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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": "68d6ee0e-c542-4fde-864b-5c11fd27e3b9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ba8c848-86b9-41ed-b34c-bcd538c362fc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2bd9a98-4a70-4eb3-b9d4-71215a9dd9b9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4be5e34-f47b-4a22-9ef6-1373d61bdbdb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b25784be-a8b1-4fb1-9c91-001658db1b37", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c880243c-776a-4873-ba70-95c06924cf40", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84c21639-2c7d-4abd-a228-337f4bf52433", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5b11f3-97c3-408b-863e-4189e926edfb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "-", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "0" } ], "variable": [] }, "header": [ { "description": { "content": "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\": 7566,\n \"message\": \"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": "6502da56-9fce-41e2-9e08-4c5270b5638a", "name": "Task", "description": { "content": "Task endpoints.", "type": "text/plain" }, "item": [ { "id": "34d1f250-4be7-432c-baf7-0bee8c064916", "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": "933582b2-4466-4a48-9e1f-294ca8f76a2b", "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": "d47ebcba-1880-4b3a-afba-57b64a07979e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9177ca96-0f70-4469-b71f-3c78b1fb555b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f3d6f1-f700-411a-862b-f27c51c8bf42", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09287693-6c2b-493f-bb94-972e074f6210", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08296f9-8f78-4e9b-b82c-9a9732208022", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea00c632-007e-4302-83b4-97a3fef91d54", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d263911f-844e-44d6-9d71-cc38fa5aeac0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "216c293f-bba5-424b-9e30-425ca57fca5e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15b1ffae-d5b1-4e2c-b4c9-d4517f29cfeb", "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\": 240,\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": "5e2dfda8-0c68-4492-a72d-318c02065cc9", "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\": 15,\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\": 2880,\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": "d5a4b04d-f2a8-4d35-b2e3-a6fbd55f7f53", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a77276f-088a-41a2-8ea0-0c3aa336ebd8", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65195e40-5011-43be-a570-c3993904aac1", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cd8e2f3-7259-4643-aba0-d38896957a16", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c30f21-c13e-411b-90f5-c449942473ac", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "388da922-1515-48a6-ba89-c74d7591ca3f", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acfebaef-980d-4c1e-839e-c99e8bc19a8c", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f39c0c6d-2b75-4fd9-b768-aa5b5e1c3359", "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\": 15,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1883a348-570b-41de-8561-ebb1dbe27660", "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\": \"WHOLE_NUMBER\",\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": "debc8e83-6ea0-452d-b123-c0cae1a9987e", "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\": \"MONTH\",\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": "f75abdd5-70ef-4a14-be69-f58499943605", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde69578-80cb-43e6-95ea-4ee3cd7adf3e", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b4f11a-a51e-4545-8e40-5e6fe8918ca2", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edc4af0a-b3b3-415a-99c3-37d29b07a4af", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828ce727-bae2-4026-b250-fcda7f200dbe", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402b9724-295b-4cae-860a-691af9f78ffa", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a45ab4e-dd3c-4c27-8753-fa440824e6a0", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6170865a-c533-4db0-bbce-db72469514ec", "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\": \"MONTH\",\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d52b968c-cbcd-405f-82fe-244decd8719c", "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": "e00d0aea-7b09-4177-88c8-a0497a5dcebc", "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": "bfe572fd-eb27-449f-bb7e-90f0a46a1bcf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "016ecf31-144f-4446-8b05-db9a5b0f05b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c776b7f-ad00-4ecd-85da-b967bddecca2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff2fc2c-6d3f-4b2c-a633-a2d86146bd2b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca345504-ce29-477b-83a5-02473d1cd2ba", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614404f9-1dec-473e-a4e4-eaf3c2ed7516", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "686a7c42-ba93-417e-abba-2c69d6f84e30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a8c542-c7f0-449b-ac14-1e53f7e8c09a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "009ab828-1e30-4b5e-8c4a-d4fb0e77f8b1", "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": "d15dbe5e-8304-4dfe-b771-a5b8219dd7a4", "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": "7d605346-8bfe-4870-b1de-baf55640e7b1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87486ebe-6a83-4df3-94c5-32f3ba850e1b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8189e52d-ee13-4cce-91df-e4ed20d8b886", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30c6bac7-2407-4721-ada1-70bc6190413e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c3b14f-6cb5-4a9b-a871-f030698d70bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d345fa38-6aa5-4a65-9d3c-e7262a4eaf88", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c81e83-0165-4bd1-b1b0-93e353804484", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5212b492-b14b-406c-80ba-581823849b56", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6686aedb-e17e-447d-8c7d-1bc28f49f610", "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": "c05e5c57-bdc6-4213-80e9-d1d6fbc16156", "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": "12243af7-70f9-43af-8147-70807c251bc1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb9574a-3217-4338-9b2e-eab32f9d2ba5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cab137d1-f102-4048-8e12-d6c21858f503", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3abf959e-85a5-42bc-a407-34cb08c98a69", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14ababb1-61e3-4e74-9ada-d2587f831c35", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5017bec-329f-4b1f-bfc4-b3f2f8086e1d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93fc0d1b-30d4-4fd3-b163-1132037ca849", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de1861f8-2515-4922-bd61-937a2f4b118b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f3608fe-5a18-4d1b-ab6c-28361621886d", "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": "46de780b-9b38-4b2b-870e-7193a99e2bbd", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a32d5f-d93c-4307-b254-99914775eb5c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c298fab2-f266-45fa-b9aa-a8d5dab30469", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34b0ba4c-ff33-4ca1-a625-ba04f63480bc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b1ad88-2f3b-48b5-b6e3-b8912f5be96f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07511094-282a-48d1-80d3-fd8946c4fadc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07494211-6afe-45c8-826b-ef17dce94891", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f36379e1-eda1-4ba4-8150-0a326d72b8e0", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebc782ba-528c-4bc0-b9a9-5cb9626fbb08", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3b26e4f-5dd8-48ef-93f4-27c2a1a11074", "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": "88c90ffa-9658-4f9f-a435-17b90ba9ea8e", "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\": 2880,\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": "71deca33-56f4-4141-811c-23cb1ee5640a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21525c2c-6d00-4f59-becd-71aca7654fc8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88264304-0e8d-46ed-b99e-694b91bd86aa", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "553274f9-78e2-407e-b04b-ade1c5dd5e65", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc40308e-23c6-4671-a1ce-35c12cfeaeca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9e98cb3-6887-4900-96b6-d02880113ff6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "011f2b5d-d55d-4b80-9bbe-6a5ca4fb70d6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda31ec9-c439-4686-9743-d495a6f82d62", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5a1b06a-1fd8-4b54-aaa6-351b9408a674", "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": "829fe52d-aba0-46ba-b5ae-16ba50cd6707", "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": "71993c31-5eaf-427d-8a13-42018a11bff3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a637d80-6cfd-46a9-97f1-e03cb04d6088", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7703e65-8e45-4bae-b6f1-2bc32551d34e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "353ec32b-6e7f-4a24-9abc-6bf5a8977142", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54b7a36a-7cd0-4997-918b-9084c8e5f6eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3adc7a61-6400-450e-bce9-64809f58a58c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e5c46ac-452e-48f3-81bd-a9fa7a3b8789", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f836ebf2-3b1d-4a89-a391-46af94d1bd4f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cc3c284-7d3c-499e-9955-76b2a0aa3fb3", "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": "custom_fields", "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": "completed", "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\": 2880,\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": "88067831-2847-4aae-b005-01405ec4cb99", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 2880,\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": "88c26e75-b152-4001-9c5e-9d201f64229c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9fd3e89-df0c-4192-b627-0f36c60e0616", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b0da5a1-8494-4371-817e-f442bdeb367d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f46b20c7-e53e-4369-89bd-884a0c41bc1f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad95057-129f-4c2c-8f16-f9a40f978af2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970db9fe-f5bc-4c71-ae19-5bb030a6162b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae040cca-6759-40fb-8c81-c50655c6ee72", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29d738dd-2d90-49f2-87c5-a9166a9b5e23", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "last_updated_by_user_id" }, { "key": "update_mask", "value": "completion_time" }, { "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\": 2880,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2621b88-107b-4ee9-8962-0629a13a7ea8", "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": "d48dbc53-c44d-42c7-a344-16f879ce5920", "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": "cd809c25-7f39-4b59-89ea-d4d1aa6a1a4e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8e881d3-83ce-4ab4-a3f9-062bdbf6c1e6", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7e6bbf6-e3e7-4835-af7e-082e04dda0e9", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a08c683-6806-42d7-bc00-8da95692ecfc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed69513c-30ea-40cd-9888-d02523ab4850", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ef40cf-d85b-4b46-a857-cca176a3ee29", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5058c532-9720-4448-94dc-0124f7abd136", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b2f0af-e05d-4ed2-abac-ff35245d91a2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16a8537b-9b60-4c3c-8d31-ecd013b2f599", "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": "options", "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": "group_id", "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": "7eb9c214-c4c0-4400-b781-3df137e855c5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": \"COMPANY\",\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": "28d68715-ca60-487a-befb-b6c81e2cf700", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e89189-c30e-4d70-9909-9da45c35b8d9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb088de-7e3b-49bb-85b2-87f043b90055", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be7af21-ce49-4c0b-a7fc-2f0f646c87bf", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb3002d8-314a-4a9f-9589-447fdabeb984", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e934b7f1-8221-411b-afd5-170d5cb7eb99", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a20e77-502b-491c-b26e-98b3c0f5e0f5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa3ce290-232f-46e1-9c4d-9f24ccd3460e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "group_id" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1631d251-03c4-48bb-9cba-ef56e9767675", "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": "ceca1942-ad89-450e-a906-3f66533b6a8f", "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": "514715cc-c1d2-42b9-85cc-47563cff57af", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92e6ff1e-70bd-41b2-bc65-f90bc61bb475", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eadcd6b-a884-472b-98ed-efb257573092", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff012904-ad47-4539-84f8-6daead0a378f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ff1fae5-319f-48e3-acd1-3c3531b6ff03", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d38a7f66-f077-493b-8291-d3c5d917d410", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f7032d7-db97-48dd-ad78-b51bfb19db47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3858a992-d4c2-4da4-9719-f70af62aee99", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "828b1fc4-9afd-4d92-9209-8f47f1a81297", "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": "e77f8fd3-a1c3-43ec-93fa-20a2e890ba12", "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": "b310c6cc-a6c9-4fd2-8cf5-a2941b4799e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d80ebc1d-4c0f-4332-bc77-25a8733719e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de2e2eb9-a99e-4487-9ccf-99460ce84917", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e501207-5e74-4305-a7d8-c4833a5f6316", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ee963d8-858b-4f07-9b44-900bdaca5f56", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7793868-e8d7-4163-98b9-16f1607a6427", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb2ebd8-740b-4697-b802-8a69878d9c2c", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "842ca2f6-89c2-435d-a5f2-13b65ec25124", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3d1acfa-ddc6-4bd6-9992-747b265ff487", "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "abd3ca1f-6035-4f11-8567-a1e353591e8a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\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": "8a70cd7d-e702-4157-9552-4b6706408f2e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3955e407-5b4c-4e68-984a-155940b82791", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a82f77dc-a990-42c7-88e1-c2d909b53fa3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95653822-400b-4843-8980-0dbe4531ebf4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e6e1581-582e-4a95-8440-4b330b63f2aa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be0c2e93-562f-47f9-83bc-c0aff3e4ef0b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0e445a1-0185-4853-91c0-1e90da916b48", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c8f6f3-fc4d-4850-93cd-bc72551a94c4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "tabs", ":tab_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "name" } ], "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\": 4504\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e814a669-f824-463f-8a58-33722b6feb29", "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": "3b1a9c95-1747-4817-9f60-edb88d03f21e", "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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57d32a06-72b6-46f5-a581-50ed04a50d01", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40f4358d-3620-44c1-bdef-51ec0c352772", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed833df3-5903-45e6-af38-662b8643d3eb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484967bf-fb7f-4d39-9dce-d8e72a5d14f1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e7efee3-6539-45f8-aa39-12a28775e16f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a549f1-4ddc-4993-bd8a-a69c3290b770", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c5adb8-7e00-4c7b-a05b-89ed8d4242dc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff0791f0-b07a-448a-873c-ec805e663a5a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6f14662-cf39-4082-b5bc-6b6b57786acc", "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": "8ccc2d78-7bb4-4f86-a2d8-a07feec852e8", "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": "d5e6dc5a-fc3f-41bf-a578-672943c55f82", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6e6b4a0-110e-40fa-892d-d9a69b147048", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "428377ee-9b62-4ed8-a049-ae49a67ec7f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515a5dd8-dd69-4eaa-bd96-a72052faf42d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d730c03e-6513-400e-8a5a-92c56495ade8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27cb521b-1e70-4c04-9e0b-b2ea4a79a1c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "979b91d2-cd78-42d5-948d-03c4877307e5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94e9ebc3-120e-43e2-a493-0250b3a5798d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61eab910-5727-4585-bfd9-cd4e03178f21", "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": "name", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "800c7fe7-241e-4f11-8271-964a255753de", "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\": 2564,\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\": 8038,\n \"tab_id\": \"string\",\n \"record_type\": \"COMPANY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff7858b6-7a8c-44f1-9d04-b2f118673c7f", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14860968-d3c3-4065-8493-8ff5749583e9", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbcee5c-8d9d-4595-b3af-799a0d55f9a8", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3a10358-9b02-4e8c-9231-076e4ff8e061", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f177c47-7564-434d-af20-99f027138dac", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22ee4cbb-0083-4fd4-aca2-4fb89c9d3253", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4fc59f5-73c7-4cc6-93d8-4053b077650a", "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\": 2564,\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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1cd23a8-6941-40cc-a2ce-2da578663d73", "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\": 2564,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c123dc9f-a1ce-4f25-b6dd-aa11f77934cf", "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": "f28d9c42-c502-4223-8987-928ec89cd60a", "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": "35c45895-0c21-4526-b1bf-b75a62ab5927", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b45e959-abc1-460a-a852-eabcb04369ed", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16839e9a-ddd3-43d1-839f-c66ac3a8f6bf", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3681513-6bc5-4250-9df5-c6035a5d5983", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ad350b-f059-4915-b7a3-ab2cc1f41e58", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef7e444c-a16e-4ae6-b563-6e138db2bba4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61fa671-f453-4bdc-9b2a-dc4f2f11b4ea", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd7982eb-a959-4a4b-88c1-ae16d10e22ef", "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\": 7566,\n \"message\": \"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": "f5f38714-8398-4664-b293-78c85ec921d3", "name": "User Groups", "description": { "content": "User Groups endpoints.", "type": "text/plain" }, "item": [ { "id": "f39062b1-c102-4613-818e-104ad2d38611", "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": "6d495ba5-5945-4318-8eac-6d215a8ac35a", "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": "3846f46e-503e-4c0d-a16e-f15d1e186be1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caa799a2-cf75-42c3-81c9-629d6673c8e8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63a9c498-a045-455a-b7c4-9e45701ef788", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88322891-0d52-4d3b-b29c-97bd093ebb23", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1d70698-a96e-40eb-ae81-eed856b89102", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88cc2488-62b0-48e3-bc83-3ba9f5390065", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a3faaa-7d9f-4b76-8b89-821a8b983a3b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ee5d21-4dc6-4c5f-8f1e-e80f9607d301", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "246ffb00-0fc3-4117-a3f5-845cbbd82131", "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": "302c5eb4-ccf1-4194-9ce3-16ada77b79fc", "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": "0e7af337-b88d-4724-90fe-e15c607e757d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b413a0ca-2712-4910-be32-6e21242c970e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f83807-0fc7-498b-aa83-dd9302a262ab", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f378617-90bc-4a25-9228-a1c3f237ff22", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501f8407-859d-4d3b-bb90-bdbb598af2e4", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c379cb37-7c0e-4197-9b4a-01510e977975", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cdcd056-14bf-40d6-95b8-151375254270", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6604476e-5c36-4ca6-afde-a89fda8a5db8", "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\": 7566,\n \"message\": \"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": "3de93a7e-7752-4d65-a7dd-86f82faeb500", "name": "Users", "description": { "content": "Users endpoints.", "type": "text/plain" }, "item": [ { "id": "b199bb69-ee40-4e20-a025-f9ae27033387", "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": "a85d677a-f08d-4cad-b40a-9395423373ef", "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": "59426cb3-9005-4cca-97a8-814e0c2d253a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2d14496-5f40-4b01-88a0-775ebb77a067", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1ef6ed-4b17-4b75-a853-227e3a999c86", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5cec4bf-2ef0-4955-921e-553acd73505b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d416de6-24a7-480b-af66-e11c8aac3d9b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f35f3bc-1c1f-43fa-88a2-19d7489c834b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa3ef237-5304-4f4c-a350-ef84d8b9f830", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "921e5383-61b7-4434-b554-ddcdb5d19971", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eef25b4e-d531-47b1-984a-6fc2f63d1596", "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": "time_zone", "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": "website", "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": "23253912-9f71-40b5-9938-14aab07c9101", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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": "9a610f8f-4d23-4e6f-881d-8164639d53b2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257502cd-c5e6-439e-b9ad-5c2c5c289d35", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d4d475-73e6-403b-ad35-8f25c3f1a28a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c481e9c0-ecb7-4043-96cd-41b67398db35", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9283105c-1c99-401d-bf96-bcfeb3907a1b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3e340ac-8fbc-484f-8b48-5a421d0a5429", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6272ca0-1edc-46ad-b5a3-7c38b61297d8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9d6618-8912-45c6-af14-d0586b4a643e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "family_name" } ], "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94666c13-1cea-422c-8e09-589bfdd6f005", "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": "261b3247-75c1-4e66-bc67-72c48de64cdc", "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": "1641184b-07a4-4f84-96e5-ccf317bedef8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a318d7a1-914e-4bb0-b046-956412e0e569", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76a8948-c494-40c9-95d7-2eecf66592da", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2932b554-d422-4964-8fc9-cc60641674c3", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab87abe3-284c-4f80-9c9c-c0904e88e5a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66393a2b-48f1-4594-8367-13e98e08f682", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a570f9-df3e-4c6a-8e45-fff76ceccc83", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1b7517-8506-4125-b86e-07d01fb907f2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbc45953-3e12-43a6-9779-bcc7cb416de4", "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": "159f6866-d596-4705-9d40-cccbce1ee69e", "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": "5cc70f69-ba44-44bd-ae94-605f5500f92b", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca839017-b31e-427d-8ea9-78d99ae6d17a", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c774b260-8c49-4066-b2d6-0d482457aceb", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c18a8a-c113-4d86-bf65-7736f3a0d8a7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a43aa21-95eb-4ef2-8266-ae78b832ad97", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12cc14a7-bb89-4acb-aaee-c216d7a3f909", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038f9539-6b68-49df-a460-58cf1055c7b5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3fa8995-625c-4e02-9058-f7b5ccc9e0b7", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f36c256-2e8b-4a11-bca9-9ce9e9d59506", "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": "069715b4-05d2-4dfd-8e2c-4afd3e763dc8", "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": "a6e1c7eb-9bd6-406a-91a4-d3ff8e677a44", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4b8308f-32c3-42b6-a052-6859cac55781", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87aafa44-d323-46f1-9604-2492b41b793d", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6345ce7-ce84-4552-bd1c-9a1c501fbd7f", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f0c6e1-0e14-4eee-b098-49bcd3d200d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2a0110-7fc7-4864-bd49-30298145f5d8", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652f4577-5507-4adc-ae28-2f1952aaf612", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79bbd13e-cfcd-4fa8-b514-83fc59224cd6", "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\": 7566,\n \"message\": \"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": "5992762b-e846-420c-81d6-ef65345bfa0f", "name": "Webforms", "description": { "content": "Webforms endpoints.", "type": "text/plain" }, "item": [ { "id": "dff028e6-af0c-4ea0-8609-d81b7a3dd9f0", "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": "4f716af3-a8d7-4cd9-acf1-aff564731aaf", "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": "85490dca-afa2-4781-abd4-5511fdb44e55", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c088e93a-1f88-4e20-ab14-19a58335e4a1", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ecd44a-e83d-44c4-88d9-d327d788c726", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90dec992-1779-4e4d-812c-a86e4bb513c2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f944d073-4cff-4d4c-b8af-8abc5c3dcc73", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb8d047-00ca-43b3-afff-285fe5d7aaec", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17fb8d44-e577-4a9f-ac5b-a53bf766d3fc", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "171fea33-7f1f-4022-b99f-332a46de7e18", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b2c6347-b902-408f-a6bb-7cb0994ce21e", "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": "91a0f753-555e-4975-9ea3-664b998f9258", "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": "ea287a92-202b-4114-afe4-b032fcba5ac5", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e73953-3006-46c8-bc3c-611b4dcbaea2", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a63ffbe-86c2-4187-a602-3c04d4d0091e", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9277f0a-ab18-4426-b15f-410b43ef2707", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566170dc-d95f-4fb5-ac3d-bd81fb37ea47", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab649867-d4fa-465a-9106-18b3bcfc9a30", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a63b5202-40e4-4b46-b43c-2a3384fb6cca", "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\": 7566,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2c6f9ba-88d3-41d6-b6b7-43d4865f7932", "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\": 7566,\n \"message\": \"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.infusionsoft.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.infusionsoft.com/token" }, { "key": "authUrl", "value": "https://accounts.infusionsoft.com/app/oauth/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "8b9b0f11-bd70-486e-91e2-130474bc7e1a", "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" } } }