{ "item": [ { "id": "851d76ad-1daf-42fa-b7dd-54b970d98477", "name": "Affiliate", "description": { "content": "Affiliate endpoints.", "type": "text/plain" }, "item": [ { "id": "c2cad3d1-1826-4b9f-945b-e84d2a680ca2", "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": "49ce770d-a647-4423-8d1a-8e81bf47eef4", "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": "ac8efb22-1852-406e-8892-8ca6ad583354", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3002e3-6ea9-4134-8dfd-3eafa1bd152e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04319607-57c9-48bf-be00-0fff80d1dc85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96267510-731b-4fb7-92fe-6a2fdd35d086", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c238db0-12c1-4b32-a83b-81f7a9eea9ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e6fadaf-00a2-4bd6-9e5a-44db4e638e4f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a170a8a9-ff5f-4bc6-9ff3-ba80eee94248", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92be03e9-cb7d-4239-bc09-ee63a8707075", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a23dd33f-d52a-4b83-99a6-38f3991523a2", "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": "6fc2a867-6c1a-4428-a606-85516006cb3f", "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": "8ccc8bb8-fb11-4ccb-8a79-366ae0ed233d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "516e75bf-9508-41be-b0ca-13a63c6545f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef47790-ddce-487d-93bf-86b59d6ed284", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4809662-779a-437d-8bfe-f69a1e429ff8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659b47fa-4144-42ce-aeb9-1ad54abc7947", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0281b6fb-a6ad-40e4-9564-97a22babca08", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6424f105-5195-4219-9b07-f3422b3e125b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "414da80a-ffe0-43be-9c14-b2f8dc9dc36b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5625135-3112-4e20-8ac0-bcabc75af732", "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": "5ae0d7b0-355e-4d31-b92f-aaae7f702858", "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": "7ce1c786-1945-4e4e-9a0e-e33e64bbcfeb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb0d94ba-3f05-4eb0-b7d2-10987534685b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5933ed5d-4e41-4435-b112-deebf26b4cfa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e860ca8c-b65d-44e5-845f-b3155c9791eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "039cf4ae-c49d-4bc9-aa2c-6c88aa28e225", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2337c7b1-2ed3-4e9d-955c-8f7594551663", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47b3ea34-c1d8-4858-817b-93f023842f33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb117995-4bcb-4074-8b28-428e18bee6ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c7e80f1-ff69-4449-8dbb-95792cae2585", "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": "1b99fc89-62cb-440b-b081-e087f4eaff87", "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": "e684c9f5-1756-4971-84e4-87e2f5761618", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c71e5df4-74df-4020-a5ae-b05185755dc3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cf74249-e2c4-4835-888d-950e11040f54", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "058ce9d9-d0d7-4090-bcc5-904d35525966", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f22be600-9316-4bad-b750-43a7ff49503d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f610f3fc-c215-429e-86d3-8d535258b814", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4609a7f-e019-45f2-9e3d-a5494745d7eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96e7d9ca-dc99-4447-8887-6c8f77a9b3ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "220d4b65-c9b5-4fc9-ad14-4c24605f6c23", "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": "498cc2bf-b4d5-469e-9efb-09e3e014400b", "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": "78578e1d-d714-4ca1-a181-1598411b08c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a76e8226-f564-4350-850e-bb083b64a441", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d221b13-9574-4c8e-8fba-762180883eb7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547b4588-efb1-48e5-a8ef-24a511fd633e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387e62dd-e42f-43a7-8c76-1b04db802379", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63aacdee-0d92-41e7-9124-6803603cabcf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f975bcd5-af8c-44f5-9f1d-19854a014ed9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb7c20d-b50a-4f42-b417-f6c1a2164284", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78da5507-c6d1-468b-8969-8c37108ae0f7", "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": "324c0e10-c44d-406a-9ad0-7ee5f9ed3548", "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": "11eb2a38-00a0-409d-90a6-6147c3c7aaf2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff35a9b9-2f1c-4c96-b155-91b1268542b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9578daf9-6b80-4436-ba55-d886499ae356", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b551d1cb-30db-4103-9cba-0f8996aa1ee9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d41f29-615b-4338-b110-64ccfd66569f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69f4841c-c94f-44d6-ab8c-547da5709ec2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f2df7f6-f86b-48ef-b2c2-bb449196e817", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfa6116d-df8f-4d0d-9dff-0af6c3562a1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02fa3854-6dff-4df4-bb85-e2c6643c0899", "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\": \"DROPDOWN\",\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": "bd06fe2e-d531-4b3d-b52e-bda28ca13d30", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0403287-3239-45f6-a2de-0ab2fce26b5f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec9f335-50b3-4529-a769-f1abdc13c137", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e9ae6b-e8bb-4734-90f7-7cf1706412a3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf63cd6e-f31c-4840-b66a-037eb476a41a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480dd4a2-2842-4d10-8b99-27ac9fb50d9d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10af69d5-4790-4d57-9e18-4a3935794c8a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0212eca7-2eb1-4c48-9938-e6a7c159e8ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53d272f9-0c8c-4914-86aa-cdc6d7b07c84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "572116e4-cb54-4a7b-97ba-f6e02c134a7e", "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": "6e44259b-a249-4547-bcfe-1d7506336b59", "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": "191af976-f67a-4ff8-bcdb-971ebd723020", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a5c16d-369c-494f-aa9d-75de556c3a44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9349d42a-350c-46dd-b045-c65634cf100f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e9b57c1-3b6c-4f34-acdd-b408501729c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7214c3e0-6440-4059-82bb-87f6d326406b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efbac529-b10d-4528-b5a7-82f2629d6810", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26dc5d3f-0e11-4400-a856-edf5d700dc87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9db9e858-55ab-47d7-8f01-99ee47aaecd1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c208367-7c1e-4ea5-841d-ba40107da4de", "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": "97854b7e-a7f8-48b3-87be-9c8858aa81ef", "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": "34bdae88-21b0-400e-8013-7c363dac040a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa974a48-e556-4344-ad48-6801730525aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0645e5ec-6b76-4292-b457-53c001c84ee9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4606049a-158a-4dd7-8f86-f984519b3b7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86dbe8ac-f8cf-4049-a079-215dd098c77a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8abbf33-1d89-489e-b413-bd4a630d0acb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7bb3052-573c-4537-b151-f3c940e374c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c01e1cd0-3934-4eff-8bb6-7a9056c47872", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2cbe156-88f5-42ee-8ac8-6c275befc878", "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": "ea2d00f4-a975-4e78-9e8a-936deb6608c5", "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": "6ac3bb6d-70b9-41ce-84ca-608f1c7e1974", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52c7fa3b-6c61-4e80-9a3b-00168f8f2f5b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "008eab4f-70c0-4d30-b151-175a5967cd67", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fcc3515-a5d5-4451-a4e4-1b4791444fb9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e308736-12f8-4563-ad29-39261d1c9cee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31595374-fdc5-4838-8f50-cf66b668b16a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b1ba8b-e6c6-4b21-945e-1b0bd850cbad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7a48dea-1da5-4dd0-ab34-63252ad71099", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eee9466d-de41-469a-a8eb-de1b43c0bf79", "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": "ed377ea3-daff-4fcd-b849-708cb8c48551", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2249ad3-7011-42e4-b97a-d17b6696057b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9561ef-5c55-4c37-a358-6b4d938e1b25", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "474ce6c9-6bf5-4c52-a95e-b1a841b9e90c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53826fd-0452-4192-b2a8-93ce2771b3c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2e39fe-0388-4506-8a51-873aa3bbf06f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f2f09e-8dd3-4fcf-8d1a-e540913f8eee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "505c045e-2d38-4bb3-ab2a-ee6b74f0bd26", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b62d8f4-2c0f-4ab4-89cd-7d0127357cc2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1217fe7-62fa-4c5f-a24d-31e0f1d970d7", "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": "7d0b509c-8e68-489b-a77b-f8f6d3504029", "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": "ba08a47c-4ebd-4d6a-a255-02bce758a803", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ba61ec-b717-4269-a6c0-66aa3eb42cb2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92076ba7-6291-4693-9ac1-0862d17e241f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a1d361-1f49-40ae-9544-cda662eacf55", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44c924c-573c-4558-9365-53c582ddaad8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95dd1edd-bc01-4206-826a-8370a03c3c86", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe35e2e2-12b9-432b-a3cc-cbee498a7df8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7699caf-f0ca-4bd3-8ce8-bccbacbc3070", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "230c816d-96e3-41f5-ba39-8eb2bc65d71c", "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": "1eae1e93-95f2-40ad-a072-d7d9ad741c2f", "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": "e9468164-d50e-4073-aa0e-60cd763df7eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a131aea-95cd-41d8-bd2f-e988d0a3df16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff4ba16-8883-4cdc-9ae3-456f453cb821", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d76a3d8-ae06-46c5-9539-3206a07dc48d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "892676c1-5092-4efc-9db1-f20c78ef24f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6220d074-73a0-4e50-881a-b7aea087b5d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562a566c-f624-4dfa-9dcb-dfd7feb84c00", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a6eac02-0db2-44e4-8182-b18d523e58a7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0b6feff-3b66-4b07-836d-d20ad9f53eed", "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": "60277b66-f4b2-4bfb-95b6-4eaa70eedded", "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": "5eff748a-455f-4976-8fe9-64123ff78e58", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ba5bdb-e763-4775-82a8-64bb0d2ecd85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43464078-9d84-4c94-9309-27b1d8250d33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618d67b7-817a-498e-90fb-3aa7e5bf2232", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b5a94a9-ceb3-4857-919b-11d0dc1c41fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d79c47-0550-4f11-a6fb-dd1a47503fc5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a22dd147-6885-4ed4-a5ad-f9f413e48253", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "868c29bd-329d-403a-b640-32fe8584df03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "938c6e5f-efee-4f79-8baa-a6d9162e8f9f", "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": "80ba6f41-6cc0-4983-af2e-486a78d42cca", "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": "af733ef9-a048-49e2-a0d9-242d9ab919d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c51b8e-e1fe-4186-a209-90066628ca2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ecf06b6-846d-4044-9779-5738c3000633", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15bb8aa4-b66e-4a87-ad58-0a809e915274", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e271841-a241-4ba4-9206-84a1fa67c91d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73f41dcb-ba68-44b4-8d95-e239b4180236", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e489e13-98d1-4ccb-8e24-7ba62db1ab61", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0759ba9b-20a6-4e7c-b596-1bd09fde3feb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5302e1a4-106d-44a4-b7c6-619c8698d272", "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": "eab69334-85e9-41e0-b7a5-8409dcf231aa", "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": "ebc75395-20eb-4cb2-8f3f-4bcdbc34054b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f49ad4b9-3834-469b-8630-17ac0eabc96e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0a0cd2-c7c8-41e9-919c-1d91605274c5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0c8fda-5c8b-483c-82eb-c92003d2f20a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c49e0b4-5813-4206-baa6-68aa1a1a40f5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f3cb01a-bc9b-4bcf-81b6-b1b0bbf8dd1c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3d6c993-2376-45cc-ab71-a251f7723d9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539938e2-2da1-4e47-a360-b30c9f5427ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14c88df6-d255-4a68-b0ce-88648302dafb", "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": "percentage", "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": "dollar_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": "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": "dd67b9cc-63bb-41f6-bc16-476b768ec487", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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": "a90b6332-d011-4753-af9a-2a4425c969d0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8d26aa5-3591-44a8-ba94-636b2e9aeab4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cfd087f-dd42-4eeb-869e-59883b2b65cf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40353689-8c49-4af6-831f-4d96ad69ed87", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1164ce5c-0643-4ff1-a5d8-71767f332ee7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9ff3f58-2f6c-4373-a21b-8eb20690693e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "407fbdca-2e74-41b4-b3c4-9e00c07e8dad", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f0b8073-a133-40d8-887b-fdef86deb37c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd9df72b-a497-472d-a56e-1309aff0bec8", "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": "43a1cad6-013f-4290-bd3e-089254e48937", "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": "2d53ab50-4e7c-402c-82a5-11a570640b00", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46b2a02c-ec7d-4d2c-9c86-45b5294ea8a9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51631966-268c-41fa-b8ee-05d52783a9d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67493234-d339-4c70-b37d-0eabbefb4991", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9966fe76-d6d8-4b54-b751-39259c5d930e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc00aef1-c7c3-45bb-bf35-df373f0678e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff901171-5595-4a9d-a2c5-5a8036b05edb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1475074-2cfc-4b82-8f69-72b696ce36b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f8e9044-a327-465c-af52-e4e3957e4dcb", "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": "13b095a9-95b4-4c70-9177-1100b1f6a910", "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": "799e334b-731f-487a-b536-77c655779cc8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe3c8a38-f9c7-4860-96f2-047b5c2d672f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fab0cda0-6347-4b7c-9897-2a01a41c1dd8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4f1d72b-9b49-4758-855b-e9f444216de6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8021a500-64bb-4d24-aeb7-82ad5df1faf1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326e975d-f4af-49aa-a475-18a5e95b3c84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17123ce-2eb7-444a-9771-bb5660f0676a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fddbb131-18a4-4106-9752-58b01455dba6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5edfe584-c13e-48cf-b17b-1033d1d39e7b", "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": "percentage", "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": "dollar_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": "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": "368475f3-d25b-4539-a837-43f3cad5a7bd", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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": "355ff13f-2126-46b4-b357-31137c29f8c2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0238dbfe-a529-48d8-b145-f4df8c83e7a3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be6fb7e4-b825-46c6-8350-6e7169b9543f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c89f53-37b3-414b-99ad-950686c14f7a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7032a420-5195-4a1f-ace9-62ad80210d65", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e51e6a-3396-4609-9542-38ff1a71b686", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc3e691-0e0c-4de0-a319-97a40f742116", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f33bcd2b-0d3f-483e-8e60-644586728a53", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be96582b-566c-44e8-b3f1-961a00226a20", "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": "a6c4a376-dbe4-41c6-8080-0248cc17c360", "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": "f5295e1a-bb92-4f54-a485-d4f444323523", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a38d0f-db16-48e0-a72f-ad4b0d4cbac9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b229bab-d41b-40f9-8883-ec69290e5725", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c42816f-9540-4a9e-931b-fbeb252e5fb6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a98677-963a-4231-a66f-fa56459e7eac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4c13c66-6f54-47b2-a061-082e28468b45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fcdb1b4-da16-4d06-a95a-e5e488136268", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3532b5-c4ac-429a-9977-b905cbb670b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab7d132a-a1b4-4aad-ba16-151c99e59250", "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": "percentage", "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": "dollar_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": "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": "80b30740-ddf2-4848-b1a8-f604b670d772", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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": "b8270ef7-4526-4027-ae0f-6c3655d14f05", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f72db49-f8e7-4ffc-96df-afb3429cdc82", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76148099-5a35-416c-aaf8-b99027e8a894", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "697e8839-dee7-4fb5-9abc-4669d1ea3d4c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e351a655-f496-4bca-9334-7197ef9ec252", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fabdb8e-c6b9-4277-bdb3-eacb37d79f23", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29811bce-a0e0-4093-aef0-f09a8eedc77e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7737a709-496f-4110-8b81-8a96fda7e2a8", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "level_2" }, { "key": "update_mask", "value": "unused" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47fbd48a-c142-4925-8e17-c11426a353bc", "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": "310b8319-598e-42ba-9f3b-708e7c5f18b8", "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": "4013c5d4-fc30-42fc-aa34-a14aff46e329", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06e3e89b-dcbf-4845-8c38-f124bc8ed813", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488bf2a0-a331-48fa-802b-6a5916fdd5fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061f9961-e8fc-4245-ac12-70caeb240499", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bee5965-844d-4a60-9cf7-4f7f3c765bde", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96308906-c0c2-4ac5-b287-879e4ed75a66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c62c248-f01b-4a31-a32c-93e9d86983fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5302916a-f83e-41e8-aa45-c68a208fb174", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bcd62bd-67aa-4054-8620-e605e490e483", "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": "88faeb57-ac6a-4e3a-b1d6-e1c4e3c33fc2", "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": "6f422259-3b94-4aad-82d2-2d5b9acd63f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da6376c-45b4-4d74-870f-fd52b5459b34", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69edb67e-f7a8-46e8-a5fe-5f122f94b965", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc81828-ad79-47be-8ee5-e7f9b6d982eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc11b768-1de8-413a-aee6-6116d74371f8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "855ae690-5918-4494-8277-b3dd437c8c01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a61bf4ee-ecc6-4582-9cb5-4fe01c5fb1cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34474eb3-94fb-48c7-9be7-d42fdbd31a94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9c83c48-4843-4464-a22f-6230ce65f076", "name": "Update an Affiliate", "request": { "name": "Update an Affiliate", "description": { "content": "Updates a single Affiliate", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "password", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "parent_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." } ], "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": "c8ae3bef-02e3-4b1e-b663-21f4694a5d23", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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": "ab2196cd-6dbc-4649-b5a4-15487717b6d1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35450a96-9268-4688-a6a7-531d9839978c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad474f5-df3e-4ae8-aafc-d97eb7b1920b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aedd5f5-f58c-44da-909a-480dc8dde7b2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "287e69ab-5696-4de3-8e41-9b7fb5d1289d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65a5677-0c25-4355-8cdb-21f14bf1f6ea", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf71661d-fcc3-452d-a97c-590f6f6d0a53", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56c08933-c0d0-425f-8b31-12f6eeb8dc7d", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "status" }, { "key": "update_mask", "value": "notify_on_lead" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f512dbc-f3fe-4382-af0e-690af1815de8", "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": "70ecfe3f-2f5e-441d-ae4b-9e70774b34d5", "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": "867cb108-aec0-4c72-ab6b-444519c1e554", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84eb29f9-5114-4cce-ac12-09d8634fa80f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "271acd92-1054-4b06-bb00-a6f06db1ed96", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58c1216-c15d-4dd5-9fe0-6059f09c0b5c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "198a9aa9-bd7f-457e-b46c-e3e6e09f7ae8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25750d41-6002-42cd-9987-8d6b32e7e580", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690d6629-b99c-45b7-b536-5044bc56ef66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d0715b3-17f4-4ec4-b769-2739bb6c00ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "371c0326-76d5-4771-81c1-b9e2d36cb2ad", "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": "87447a4a-03dd-4d4f-b996-f6c77224e9b6", "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": "cf3d1241-4597-484c-8746-aee2b3c5aadf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09239afc-ac82-4b7b-abb4-02619b6a2111", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "705534b7-7c1e-4814-a870-c4eb70cda712", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9e61d2-24ca-4fa0-bdac-220d85ceb014", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f434ccc8-6d92-4070-beda-9b827396dae1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1f3e72-e47b-45fb-8078-dcbc9b9f6aa8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776fbe21-c546-41c2-9ed4-58920762aed8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff116193-f699-4fb9-a97f-ccd1fc77f768", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c4d1a9d-312f-4e8a-a2a4-3a284403fcbe", "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": "e8c4ce43-91d8-43bb-946b-fbc223accf44", "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": "52cedfea-fa0e-473d-a33a-1f2b6ec8cb06", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "941c520a-d5c5-4c4f-909d-ca2adcd8ea16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4df1159-8b20-412f-848c-ce91aacfdc60", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87a735ee-94c6-4c72-b0c0-89307486feb4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8974c661-0ad5-4f65-b324-b875cdb56f17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1ae82f-dfaf-43a8-96e4-2a25e536ae20", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d67d447-3a0a-4935-87c0-91453aa70288", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ce08656-beb4-4731-ad23-11c7aad8b0b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61c08a7e-492b-43f1-84da-e3a2030b02a1", "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": "72ef07d2-a7d5-47f6-b5db-4ef35afb6bd8", "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": "5ad602df-b6ce-452f-a056-18a47b105415", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbdc31f8-9bea-4d25-b566-a14371646b9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d466517-f471-4246-9ff8-5a8c3d822f92", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7ddd62-1680-4825-9fc5-8d5d77a8ea68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3914da7e-e8f0-4908-9917-1ce25519b700", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef60485b-4367-4413-a3a2-eb1c7b7e4242", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d13afe69-3d57-4888-9105-807c921ace33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09266b93-f16a-41e3-83d6-55bbc01c12d5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53e6d591-e095-4b49-8b74-a72f973fb5cf", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "fb04c073-5941-445b-8872-008f043e78df", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db32e4d-f2f2-40db-812c-bbd769ca9798", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dde8db4-cd29-450c-85b1-58e6052dd6ec", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a61b8223-6834-4586-91df-888267a2bdcf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0615d8-6373-4de2-8442-bef0b8f83e4a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c0baf6-2c7a-468c-b26d-8e5b01b5de72", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1352b54-5313-4256-a4a3-99362070ce6e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65a8aa8-9384-4a1c-8e4d-2f59db78f385", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32772be9-9c6d-42a7-b6f7-58ce9d29f37e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf52fb51-df26-4c24-8148-3679dd81a7cf", "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": "2b02f8b7-1fc9-4486-91ce-7fd2839242cf", "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": "4de9045d-7c9f-47ab-8df5-66b893213d84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f3191d-c1c5-410e-a166-1126aa4e0552", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "192c6ea6-0f34-46be-8de2-853b5ad34278", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32fac92e-f718-4e61-bc0f-3a3768c8a9c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78e49a1f-7735-4b8c-9db5-7091b3b7675d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "185b540e-701e-46cd-ac7d-5b4e43d4e429", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e110d08-2965-4e64-b52c-7ff7ffa78134", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d939ea-9a4e-47c1-b83a-02cd3c260eb1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae4a9a31-ca78-42ea-9e16-ece1b629f2db", "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": "3f72bdd8-3103-4c7f-af2d-e2427ccbfb20", "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": "ad52a3f8-fe8d-405b-86f2-13336ed72880", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0bd4d0f-eb8b-4a72-b5b6-19a5b55e31bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bea448e-bfd0-4cec-8457-5b4441574ab1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce49243e-a302-4c9a-b21c-aca9992bc8c5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c07214-09fa-4a63-ac72-98e49a2815f7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc17ac0-3e0d-4771-99f6-a3b56e1690a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70529a45-0b93-4456-b53c-38ba85343eb6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b280edb-bdf3-448c-b2ea-69e5ae12f38d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cda46be1-be38-4932-beef-c57262e17cdc", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aea6de8b-a5be-4a6c-ad60-66a8c80842d9", "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\": 2514\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": "17f15486-31d0-45ba-a69e-514e071de0e3", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f78958ff-51a7-493a-a031-9667dbb4f00d", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "191d330f-ee74-4241-a1d3-d1b61dca886e", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ff64c7b-1a72-41ae-b81c-05fa418415d6", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf221ea-f32d-4c1c-adfc-513d839fef65", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1310411-8692-42e6-91d7-f037a6ff34b5", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a73399c8-8250-4440-9e6a-1fac09681bce", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5766208-df67-4efe-9d76-937f2dbfbb72", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31b6a2cc-8085-4de4-8e41-0bfc58a3fab7", "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": "01dfca10-60c8-4bde-a866-86f6157b9687", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c05aa5e-b43c-4c3c-b191-cb43f80b803b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07568bbb-fd50-42ca-8c6d-ddf08a98b7e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a48a3c0-d1c7-429d-96cf-c91152772053", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "996ae97b-3b6e-49d2-b6f5-7fcfe3e46dfe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c22979c0-2b69-470b-8010-6b9a74727af0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09859e6b-d20a-4fc3-a940-f6552556e329", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73d16a1b-0e22-45a2-bc45-1efb18f63acf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ba40304-ab66-48b0-81e6-f7611403cbbf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e3b3a5a-7a8e-4c11-95a1-3a59c8d2d0e4", "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": "dde32102-40ee-4d3a-bd30-89ed83a83dbc", "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": "c2b4e4d2-595c-49d9-a549-d108bede353b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2df682-6f84-4f2c-bd36-fbffd935db89", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a3562d0-ddc7-4f95-ba35-ae794cf35684", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75797e81-5fe5-48fe-992e-a5c8dc23625e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201dba5f-cf68-4323-ad41-1c32909235f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f1cc31-17f2-4e2a-ad1f-95ea3595ff96", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a9d0735-9031-4573-9ed6-fe3172932c7b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e117925c-93bc-441e-81ee-f5826acbfdd9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5e6bf40-a93e-45ed-b1a1-d93d4ca29220", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9892e1cd-51bc-49d9-a316-739930d779d2", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba2d7b5-74ae-4548-abf1-5435e2502da7", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2655bfa9-d9f0-4ded-93f3-bae36fe71fd4", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84659d76-4e42-4ade-976a-2a8d71746fcd", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e6e24a5-1702-4ec2-b55a-cddee64bf47c", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14ed745c-0d38-4756-b4ff-361930a1af2c", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fbf1e3b-8d39-40f2-85c5-863a21c08a1e", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f1932d-aad2-4272-a5a6-9b83462bedb6", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d5e646a-63c8-4e5b-a6ec-6ef2cafb39a7", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd3ca8a8-2a5c-432f-9a6b-6ebc6d1fc896", "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": "342bbf18-3309-4d14-a457-46bc491d528e", "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": "5a48848d-2a49-4300-8657-3ab7e2ed4722", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12330f96-a8e6-47c4-b3f1-72b3e420e8dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d523b66f-7872-4f85-a520-2d6e0183d361", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58b90a85-3c61-404c-933b-cdcaebdfc716", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5bbae77-c1d1-40d0-a0ed-8a138e8a5aef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81456a48-b9f5-474b-b15b-bd29dad2774e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ee26f2-23a7-4266-8c13-521b22262908", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a1eaf09-c44e-40f9-815f-c3bbdc0f09f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db7853b9-ad4e-4700-99b9-cbef939e98de", "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": "c773fef3-1708-4975-98aa-02e00656a8d9", "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": "683684fa-154c-4a2b-b963-f6e09e0577b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e0df453-4eec-49fa-9778-0b436759c4fe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998c0bb0-f648-4329-90e8-86e00a38db41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45a29a23-ea28-4283-8dc1-7a678f9bb8ed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f85940a4-5eda-4614-9c90-06c0d6e55156", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "899ca950-47b1-430e-bf81-2eeedd1d5a98", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c39c77-f08b-41b0-95fb-8cde219b6226", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ed7ad8-668e-4af3-a166-a515744efc40", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1554fcb7-a43d-4657-9f4d-ab5851ab58fa", "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": "notes", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "priority", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bbe816c7-41a3-426e-bfcf-1d8557715f1c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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": "723d73c8-81fc-4b01-b4a3-6913a89a4ba4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bec346ee-9b2a-4a0f-9420-c73fde2ee8d8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c8e84b-4cae-4d4b-9059-ffde7904f3de", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c89261-9fd4-42ab-9897-4791ea3b4ed4", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b55672b-98f0-49b0-9426-b71ead5e8b2b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3bd0ffe-57f5-4aed-b402-7cd2f82d000f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad5cdba1-7770-4f9e-810a-a2a7dc00bc08", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15faaee1-1931-49df-be3c-db4bcdba7e65", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19342db3-d73a-430a-ab6c-7cacf0a6a16a", "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": "bbc8c037-f5fa-472a-9f70-1502a460461a", "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": "a667a1e8-9ee7-41ee-ab83-22e11df5e9e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea918c0-5744-4797-866a-456ed86d9973", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b2c359-9b0d-4dd6-8637-43f68f1123a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "151d9359-2596-4c73-86c7-8987ea26c56a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec8472ca-d06e-4227-9fd3-3c04b6c6a5af", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9eb5568-9c3d-48dd-84ef-0dbdfab085a0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28f89194-7d39-426a-9e04-a887f16e9d4c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75002aa5-e977-4e39-a39a-521fb7d4293b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "435fb2f9-18b3-4259-aa34-799014446750", "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": "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": "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." } ], "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": "6ab52acc-0784-49a7-8f14-a795e8f6341d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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": "a539783d-93f8-44d9-ba1a-adbf07d9f61d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f7f3825-4c72-4508-9384-429f290f41a2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d63f695-690c-40b1-8c37-188de2846e55", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c424ea4-0f9b-4278-992e-9687bd8bfbf5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "975a5170-4ff8-4568-bbe5-6743038f887b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de0a927-711d-4a3c-ab56-b9c6d643c0d3", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e50ce597-2a0c-45be-a342-567b25636591", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f3fa1e-abc5-408f-9ab2-0c098badddfe", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "url" }, { "key": "update_mask", "value": "page_height" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62853a30-040e-4edd-8a3f-d57231ee293b", "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": "c46fb815-cb81-4971-8f7c-5eca34f7b62d", "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": "c26057ca-abe6-4585-8ffc-d3f9a3b3aaff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e66896-d3e3-4e60-a3e0-3c469f965e5b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "722f0a0e-a0f2-4948-8af5-7eb8090c85da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8ac7b5a-bfb0-47a7-a29e-b226a4402156", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f9cde1-0a06-48bc-bf3f-875f57ae12a6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "013a7599-ab0b-4938-9ef6-6d45ce781933", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1330c121-0080-40cc-a7cd-6909a8540d10", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88e961ba-3b4a-4e96-be60-48fa7d803e5b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19bd34fd-40c1-401d-a7df-24408d408a2e", "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": "8e709dfd-a8b9-4cb5-9235-4861b10611c6", "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": "fa67c64a-7630-4bfb-8c30-0bb89e86dd39", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe4a280-c5f3-476c-a567-0c0e17d11142", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "625a9bb9-c579-4b74-a857-fce1fb4bc3b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a39782-45b7-48dd-b1ff-f39e8c3ad73d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a0fb4b3-692e-4c45-b302-48b0928f64da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada2366e-fbfe-45bd-9cb8-4f642ae17de0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beac8b52-6e9b-4cfd-a6e8-c94e5f4f9570", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1710e3c-7fba-4912-b4fd-fd99fddd11b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e867de5-47a4-4363-80cd-e6801bf3155e", "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": "4bda7d30-c685-4e9d-a247-d3dbc029336d", "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": "5fb1eaaa-83fc-49fa-b15c-2430230ac19f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf4e1d5e-2226-4ef2-ab1b-9324af05b406", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfe9fd92-8513-4767-acb2-d59008b3f9d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f5c4db1-b844-4d35-8b88-ec7dd62ea97d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fee30bf0-7b66-4952-adee-6fde80593170", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f5eeae-4767-49de-826e-724a204b248c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaef2c19-1274-420b-a790-34296de33619", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9c0af8-9f82-4af4-85ae-fb2c3838940f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d56d594c-805f-4575-8d8f-396f0e57f329", "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": "8deba687-c266-4ba2-8ad9-09f1c1098912", "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": "76d876c9-c9d1-40f8-8037-3067f47290d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd21781a-25fd-45b5-9fa6-c3550a8d5c8a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073c93b6-0632-49d7-81d4-a44089b2d82c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d73ca2-d2f0-4ff0-8913-5626afe8ff95", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa64133f-a131-4dd2-9433-72ca592522cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b962f30-2fe0-4ed4-ac80-0db188b7489e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bbb050f-c71b-40dd-896d-c035f151be2b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e11b7e6-6f09-483d-9716-48ae80be5d2e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62d045dc-b231-435d-a834-ad9f70ce5480", "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": "8c338761-ec67-4cc2-91bc-cae11beed812", "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": "8840b98e-3a1b-4aff-ba70-d70e9a2efd03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "939665aa-e1ad-4c03-9de1-8999f245bd7d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "436152a8-e190-4643-be1c-bacf177f8086", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ab7cdbe-ef05-4a97-850c-74ba9021168e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b890e14-4ce8-44db-93bf-0806e70423ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4057a6dc-bbfb-4573-bc78-e333ca7cbc43", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41de0127-95f8-41ca-a737-1a622ea06b45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b091cba8-06c2-4236-ae24-f3f574e644f0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76f22c04-82cb-41fe-90c4-eb6c29db779d", "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": "31931e96-dc51-41e2-8eb5-02f454406d29", "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": "410fbbe7-4052-4fde-8d2b-2c24cf73b25c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a4e5b27-6fa1-4da7-92e6-d2d6faba33e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7272d4e-9efa-4756-8ba9-bef684fd7560", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "490fda5e-cd9d-4671-b4fa-a0073dc84baf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d423aa6-da61-45b1-9859-c8456f4e8cae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df562bd-ca09-46b3-a650-0d4576742892", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c07675a3-8830-42d1-a490-01f86f63237b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca2a2f2-1445-4494-ba9a-0be37f9bc416", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10dd403e-538d-427a-980e-b4ee0192fba5", "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": "51be559e-c386-46f6-b5e3-971f3911c2f1", "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": "cb825c0a-1313-424e-8b7f-22967b2b0ec1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9456ad5-6f8d-47a4-9aee-e6c0b4238805", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8213458c-3399-43ac-b71e-033a7a236715", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee91d901-2ca9-4625-8026-a09a96c81ced", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd87acc-9086-4090-8508-05ae2708ca72", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d982c584-64e9-4af3-916e-30e51ee21ec0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5923df48-daa9-405f-8508-396d8be1af83", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db73951-faa8-4587-8c05-69ff77bf8742", "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\": 4327,\n \"message\": \"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": "fcc39344-1fbe-4f20-9b54-88fe51b1f105", "name": "Automation", "description": { "content": "Automation endpoints.", "type": "text/plain" }, "item": [ { "id": "fea4e699-7ad6-4ebd-a20e-06c5140c1240", "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": "8e9490b2-094a-4e9e-a7ab-81172060db50", "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": "ff6b83c5-f421-47c2-ad45-496b02c9b33c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d4f40c4-021f-4bd0-a2b5-7991faf38311", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd21f2a3-633f-4865-8b4a-d87854928d45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3026e9f-f2c2-4319-8523-1259ed154d39", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d50204db-e447-4c6f-b960-47f28377b2e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "168c7612-ea40-4925-9efa-1a3f50f1f7d7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d1f730-664f-431a-9d9b-3c90f2e4c0cb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf3be96-793f-4cf7-a67b-58c35bcb7d42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df910d4f-c1b5-4687-827b-4bde2c590fba", "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": "3837e39e-c20b-4e03-92eb-eeed5fd20d83", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "automations", ":automation_id", "sequences", "{{sequence_id}}:addContacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "automation_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"add_to_automation_sequence_results\": {\n \"key_0\": \"SUCCESS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "043605c0-f0f2-40e4-8118-d6c06645a4fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ee375c-8302-4671-9624-f4fb28e9dd29", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30009435-af59-4a70-be7e-7e1a0bcbc5c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9033ccbd-6b3c-4d7b-a1be-f2844bd58f2d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d3d1df9-1ba6-4d1a-b1d3-ce3f3edb4f30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea0c7531-8c9e-4188-bf31-09c8ee54cf5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf17cc0-f4d9-403b-a6a8-3e61641a37c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16efe400-0dce-4b5d-ae33-fbfe37611c94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "944ba4e6-0327-474b-b3a4-4784d8d93965", "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": "dba57980-0206-4cbc-b6ed-a7fd08c07d65", "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": "20835dfe-0e2b-4a00-9d6f-b625ffbc6ba7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e3bb940-9167-49ef-ba48-425227c45308", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abcd6e57-e0c5-4d21-87ac-6d9e5de9a6a2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d49c6da-4954-4f21-93a2-aa0a381291ef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81b97d60-dcfd-4ab0-9a48-b30c794231ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3699dfd4-96f1-4692-80e8-ba52580e74d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c630ab7b-5e8d-4bed-b48a-fedf0fad1ae7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e00b511c-c616-4150-802b-bd523cd69c49", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "701f19fa-7dea-494c-bb0d-27c253c536f9", "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": "a0fc7712-581e-4845-8a3b-9db8f5e8e06e", "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": "8ba37bc7-c87b-4b2f-a0e7-dbf75e98f518", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc7b3198-744a-42fb-8330-09bfdef92d79", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e8786a-935d-4422-a74a-d2713f66785f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ecd2714-129d-45e5-bef0-218466a69205", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec8b60c6-31c8-4782-b328-1778fd668b07", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82089f33-81ea-4b2f-b840-85e7e2b67fe0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5afe9f1-2d5e-430c-bc94-d71cf9775763", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5709783-4f5d-4568-baf8-f6be2d30483e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9db309dc-acce-4f8a-ac4f-8dfed4ff6149", "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": "8ad07e43-caf2-41df-a145-2ef90039d98c", "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": "7f7cdb63-cb72-42d3-85a8-aecd45797b81", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9fabdcd-a39a-42ad-a928-6b9ba4a5c4bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b605a89f-2584-4881-a58b-af1e4f193fa3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a50a5b18-90cc-462a-ba31-c9a5bba8385f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b034314-1147-4d4e-8110-89bda246a940", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c153f64-73d0-4e2f-9d25-7828d5a2f2cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40d60313-2cec-419c-bbee-d1124611b56e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "463aa051-733f-4b25-a4dd-e35e400e535d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2faaeb80-e827-42be-8c77-7c34545a1068", "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": "d1361e24-94de-4b3c-8c0f-01b3a48e74f7", "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\": 9858\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f30557a-77e7-4b17-8dcc-e03d7a064404", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d198285-db48-451a-915f-7abf95a8fbc1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb98f77-9c15-474c-8c6c-e96ce86248b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2244aac9-6db6-4262-b1ce-d36454c7f31d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29d0222c-43af-46ea-89c9-5dd8e30c87d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5af5fd2a-6f70-45e1-9a8f-4e0f07cbca37", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2d0115f-59e8-4483-ab6c-13a533808cbe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1b91614-cd59-47b3-9f77-67deee4b2bf2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90d7c15f-c1eb-4a19-a23b-0665b01c75ee", "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": "8259", "description": "(Required) " }, { "disabled": false, "key": "automation_ids", "value": "7129", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "539549a1-6ae8-4dc6-8a74-b72c61aaf33f", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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": "04986bfc-885f-4b05-931f-a8b215b61c20", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70f916c8-c426-457b-aa6d-cb00b6c03ba7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a4b0af8-fc8a-4f16-bda9-25cdb6aa9936", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "778a3966-9d9d-452a-a01c-4e8cebcb40a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876744ca-3efa-44c0-87cf-e97f97a79e12", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7c276f-ae88-4c38-8401-8e3e1243f5b5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4086de75-102c-4f68-8cea-417200369729", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fd99c7e-8449-4c0d-a195-38c6c4657059", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "7386" }, { "key": "automation_ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a91689a7-8e49-4114-884b-c21cccbdedd7", "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": "1ef1d713-7555-43b6-bbe5-d177529e26fc", "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": "61eefb47-7e88-4013-b797-ab469b5750a9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a0e4b13-5a7c-433e-b026-5a050314e64d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a89dc0-1701-4562-985d-ed4ed85226a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "531dbd41-8b20-45a2-8e9f-2dec5eca9fdc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b03cfa0-1b3a-4564-9940-ce3f78f716b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acdf5ee-a2a2-4d02-9f26-09185f5852e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf5eb318-187f-4010-8a1b-8bd6282a4542", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "931fed8c-0de5-410a-95d2-8e6f2e3b01b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9901fb54-a79e-4d3b-9c0a-1dfd2731c2df", "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": "05805c9e-1d22-42e1-859a-8c6794218085", "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": "b0625386-b1f5-4984-a20b-faded7efd11f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf7fd59e-e986-45a2-8771-64a0c8d5e143", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a17a2c-411f-4af4-9cc1-0b1c43ad7f17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8961391-23fd-4cbd-a5da-81e81dc2f3b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dfe09cd-98cb-48ad-85e0-15854422b65b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ffd858-1bc3-4516-888f-9b41d532086e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402df054-a6c9-4fac-a2dd-a992c8d18ca2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f061f5b3-2694-4926-85ed-55a6ef90dcfc", "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\": 4327,\n \"message\": \"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": "97298d21-a868-4355-af3d-ca39d888f248", "name": "AutomationCategory", "description": { "content": "AutomationCategory endpoints.", "type": "text/plain" }, "item": [ { "id": "e574aa84-cfc5-4246-9837-ec8df1762e52", "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": "67769b40-d87b-430d-aa70-7caa4b5590d7", "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": "3d713616-ada9-4c07-9baa-cafba97c072a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13390ce1-cbe1-4f5a-a0d4-29aba568c2cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baf0c4ad-211c-455d-b375-01c76dd92530", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fcec46-c524-4708-83df-659533cf8edb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df8c9e7-3ab0-4ed6-a70b-916eb28a950b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1bbef5f-605b-4b1e-ab86-ae42c5967970", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5269838e-de5b-4f38-a3da-0a47a8570581", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4148ef34-4993-4ce2-b866-8e4f905af59d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6a9d05d-a710-4c10-b4fd-3ead4cec5997", "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": "f17750f6-507a-4ceb-9e9f-4e68b19740d9", "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": "047a3d5c-d9b3-4000-93d7-25f4a8d9da39", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89fb90db-43ab-4241-8785-b5a82c498797", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1595235f-9680-4f2c-b263-ad702219c534", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd6da3eb-c946-4ce8-b165-5ab8e524f7e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29a71270-2687-4b5b-a45c-eb83616e0384", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a9af84-ad72-461e-bdf6-1fee8da44df3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd1d3db-c371-467c-a32a-818808fc54bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c14509-924c-4267-b023-55a63e02aef6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "808ef7f3-dcb2-4631-8b34-20812a16906a", "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": "8259", "description": "(Required) " }, { "disabled": false, "key": "ids", "value": "7129", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c7d0e56e-35de-42c2-b16c-640f5d981372", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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": "8e75a903-aae6-4a0c-93e7-ccadf792c242", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02febc33-bd44-4d40-ba8d-ab43efcd7205", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dcbc65b-1352-45f6-9ee4-1d4bd2e033c4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b395757-a8b7-446a-8278-8c24bd2dc524", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "051e45e8-e71a-4fe6-b01f-df0cc81710c7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad85055b-3da3-4987-8952-d2874ec622e9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df3f25d-74a2-4738-aa49-2fe237fe1c43", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d540b21-5d08-4e9a-b5b0-df09d56fe858", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "7386" }, { "key": "ids", "value": "3711" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1de21a2-c05b-4391-8729-deda3b91293c", "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": "5059de27-e21e-42b2-ab89-38c1fbb295c8", "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": "d0b157dd-8954-428e-a8f5-75559fe26598", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "565371a1-a70f-4bb6-8647-1d6cef39b4fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88c396b8-8791-467f-8bbd-6ebd936b808c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb9169b-2122-4aa9-9537-c8decd040c66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa45dcc5-5a8c-4036-a2d0-485f06ad5277", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2669dd41-1d0c-42a0-88fb-e772043e12a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b09651d1-98e0-44a9-8c48-04f8b9a4a005", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93beb92d-fa53-4f6e-8025-94173ac34710", "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\": 4327,\n \"message\": \"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": "06464b8d-d935-4b71-8688-fa6acae0b7fd", "name": "Business Profile", "description": { "content": "Business Profile endpoints.", "type": "text/plain" }, "item": [ { "id": "517ce57e-13fd-4818-8c1d-9d60da1f7ab1", "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": "d4b75e13-4c25-451e-afa4-f53e2f181b29", "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": "6a176016-0800-433d-8ddb-24e6887f74d9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b0ce6d-dad6-46fa-9b55-35f0d15c4979", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d580f13b-fdef-4bf2-bff6-a2843a6a4f0e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e6d20a9-b5ec-4f23-ad4f-0018e86987e1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4dcec4c-131f-48c6-b6e2-d1da7a07c0b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc67b4e9-67d8-4db5-8a98-fb8c83e6270e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecb94e98-688c-4d7d-ba06-f708628298fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cc047ae-9ca1-4b18-b6ff-b3d597786757", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f3b677e-f154-4822-b95c-8f45c3a733ec", "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": "phone", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "email", "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": "eb65c8ed-a686-4dc7-b668-ab35ca625149", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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": "07fa8465-0f74-4ebb-bb85-d6870b5fa946", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73dfbf78-4d38-4e6a-bcd3-e038ebe70625", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c080d7eb-c112-4194-aa17-a93e2b5c28cf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "567b6a03-4942-436a-8629-e0b5e6e34418", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8681a5-e72d-4080-b73f-39cdfded7742", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6d546d5-d395-4fcb-bde0-b84992e401f6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bf4cba2-7bb3-41b2-aa40-1ef5505ec3f1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bee0d53-4231-4683-8908-355cb75e559e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "address" }, { "key": "update_mask", "value": "business_primary_color" } ], "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\": 4327,\n \"message\": \"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": "6fc7973b-9b35-462b-8886-2fca064c908f", "name": "Campaign", "description": { "content": "Campaign endpoints.", "type": "text/plain" }, "item": [ { "id": "b6a8cec6-41a1-4d79-9283-5c3224d0dbd2", "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": "6a71a816-dc9c-460a-aa78-e38836e632d1", "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\": \"CONTACT_DOES_NOT_EXIST\",\n \"key_1\": \"FAILED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a3082eb-3415-4619-99d0-b77c91a166e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6787ddeb-c17e-467c-b731-20bf9512dd59", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2146d96-7c58-42a4-b7e2-d819d1d2d65d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a5fa8c5-1b07-42ad-bf5c-66e542988ddc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2338081-fdfe-4837-98cb-aa3fcc1fc69f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12759687-8c34-47d3-83ea-84eafb191fb8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd9dc64-e869-44b3-b269-e3986907c813", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed315df-1ee7-45e8-a15e-65c2a4cd7cc8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d19e471-c92a-4a42-96bd-83eb23a5d80f", "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": "a8960cd2-b2e4-4685-9532-a5fda7290ed2", "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 }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e1c2ab-2706-4d3c-8bc8-a31c47b52f6c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a069fd0-1498-4337-91d5-c72bf033e557", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58edc0e2-f9e9-4781-8428-b2f7846426d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6249ae6-2507-4ab8-b3e4-eb6497e56b04", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde486cd-2847-4389-9bc0-61d5044e847c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776cc901-2712-465a-94c5-3a14f93070e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51fb29a2-7ecb-402e-8f62-3d6231ff0160", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e4d7c36-a65b-40f9-bd20-ced16ddddf68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33797128-6971-43b3-886c-5a5d5a759e5e", "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": "25fae8ee-6695-4253-a770-d0705ac90be3", "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": "47bf1c29-f2d2-421a-bc9a-2c4f81629a30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34918957-3d51-4de5-b9ac-7eaf94b6410b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59268cae-9933-4571-839e-dc96790f78a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d1ee8c-69b7-48b0-9e75-4f386d218e58", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b437b470-9a21-4d37-a79b-d9dc7dee66ac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89a7596f-65d9-4951-9351-c0ca5c2d9b84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea1b041-81eb-4475-9eef-14ae00a00cd7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a36f8a47-70b4-450d-b4c0-3c418c6570aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46665f8d-9f7b-4f21-8d6c-52e23d36ecd0", "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": "b11a5a1f-2af9-45de-8e37-ea4df6d44f86", "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": "de8fecc5-021f-436a-b2b2-e799fead513d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "295eb80d-48a4-49e7-8471-fa8f9beb8512", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29feb81a-c049-48c1-a986-8c3f02262c36", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa0c0d24-8069-4ca6-994d-afd3469508c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d3560a2-0e23-4da6-822a-d49702be641f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe0d3ab-8c33-4c51-9eb6-b370d7d33859", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f454829a-ae6b-437a-8a24-de98e3effde9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ade81617-8609-468a-b9b3-cfcb01141bb7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a4c4d23-b8bd-4687-8dba-93d6728d01de", "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": "9fb21017-73a9-4ec8-9e18-6e988ef6025a", "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": "e4d4e728-6c6c-4347-aafb-3f417ccc4fbc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f64cc9df-0609-4e13-8105-ac27f561892b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b655b00-64d9-44d7-a4b8-867ca2f6e588", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c47d682-66fe-4520-b7a2-0d228c05bd5a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af73567-4b01-4d21-b1e6-f18dce5883bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1425f6bc-65c7-46fc-a504-56bda027dc5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb67cff-73e7-49ae-8e48-ef3deb76f53f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c75c15b1-edad-440e-a16c-155f56a8550a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f4a45bc-8271-4154-9625-b52e9cbcb793", "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": "96252a6f-9d2d-4ffb-b506-913269e8b8ed", "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": "b352684c-2857-4ca6-b9d4-cd3058bbbf8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e50bcb94-e6b8-4fcb-a83d-e69549680b21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea3bcc4a-e90d-48d5-aa0d-9496fde8810d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3c79b13-b5d1-4b5b-b1b7-e30532a7a65d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e91d0764-38b2-4326-be25-ae7ba5e97ea3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68fb7096-b16c-4e92-afe7-672e152fb65c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6fcbad-5a4f-4d9a-9df6-8f923e9649df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3b387d-3c91-4653-9007-7b182e72e6ec", "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\": 4327,\n \"message\": \"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": "4cc71714-4f10-4974-819b-9f646ad5fcf0", "name": "Category Discounts", "description": { "content": "Category Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "93365ea1-78f5-4d56-9ec3-00906f1a2ea8", "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": "87e36df9-6777-4398-bce6-6d885e1695f0", "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": "4f932522-9e9c-444e-ade7-78295c39f9eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453c72a1-f1a7-43a5-b8ea-30130e7e0c72", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6276a2c-c463-4dc4-88e2-0b56c8a43cd7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1505f6-93f5-4405-be9c-d7c083ff2e64", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c66da68a-ae75-46ba-b427-310115b0306d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91c1a818-d291-419c-b149-6c50d03a0907", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84420976-099b-46d3-b98f-5ce78730d82e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb37734-eb00-419f-9280-72eed8767991", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2671ec87-2ba1-4889-9ef7-8285bac4b3b7", "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": "81eb32a9-06fb-4eac-a401-0850a8614a4f", "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": "f6e8092f-c4a4-40d2-85e1-a89dc5240252", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f29016-27fa-4ad1-bcd3-45ed115bea48", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add5d23d-f256-4820-8357-ad6464af0ebe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0340e308-fdd5-4018-a95d-f75339743512", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "685c6157-68f4-4bdf-88bc-61bdd47df761", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c78c604-0612-42db-a24f-1e04b29b0b5f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c931ec14-44e1-451a-807d-7870f488dc7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f977bc7b-a3de-456a-a5c6-6b65710f6bf7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aac5e647-6e92-4782-a196-e8480ef9e8c0", "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": "ccac1f47-f6d4-413c-98cd-e1620c726d99", "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": "a2580080-cf98-4626-8a54-e766a7b1917e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b6ed65-d852-4229-bce8-fa26768714dd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc835efa-f032-48bc-8349-a89ff984abdf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d24b87e-2e98-4f2a-b623-cdc8aea39ffb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ce25d8c-462a-44b5-8349-d526158d2347", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "337fb3ee-9801-4ab0-9d5e-f7da664a2a91", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "300f3c3f-70b0-4042-8e62-94a2f1b5579a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad926656-2cd2-4f1b-9449-fe1bfee5837d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4e6e9a2-d08b-462e-8f44-771e5fc4d482", "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": "892587c1-49d9-4d02-9671-bdb96b765c24", "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": "88df44f4-4b32-443e-ac38-daa00429fa1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a97eea6-a3fd-4e26-b37d-d0d960730ba0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10237f19-b5bc-462a-9092-b3018056a52c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6885e03-5502-48ed-bb36-7002154f3df6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34612b53-3cfb-416e-8156-e9dafa1ad19b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae26626e-c69e-4b31-a310-76e49efcf28f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75073736-7f03-4bba-b432-6d5192150d68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c933908-3b4e-4910-a25f-556b30b22a21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "645af19d-a6b5-4d5c-8ae5-54655d9623bf", "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": "92e3aa56-ba4a-4ead-a1bb-62a8a99ee685", "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": "cd732245-5ed9-4931-9efa-495c61178341", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cbdf3f5-d629-4379-9f85-1e077adbca3e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2b6af5e-7ffe-411f-9fc3-a8363b7054c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a2b7721-9277-47ce-ae31-b9bb831b3340", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716b0ff0-e020-4f26-a7d5-214e1ca5a90c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "848942f8-20f9-4fcf-8a6e-1315c09799ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f0ce93-ff30-4d2e-8d6c-c5d98737f800", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c40ea9-3c73-4510-a644-b68045c164ff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d01fe8f3-f00d-43d3-a2b3-610c03c2c133", "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": "apply_to_commissions", "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": "78ab9d9f-3021-4868-98f6-627a2c69adbf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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": "92b5c154-1b5c-4bea-a8fb-0755e4c7d6f5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56867afc-6471-450b-a4f9-51e366a02aca", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9b504c-e9af-4bd7-800c-cc5cb52143db", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1a99cf7-c4f7-4310-bb65-b06f2359d89d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71f277f4-15f1-453f-b365-81df902d0d08", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2cf9ea-2072-467c-9a37-8f678c415085", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4ca42a-ccf1-4b36-b3a9-e51a7890b72b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031cc73e-bf5c-4f2a-bd23-53e1625b32c2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_category_ids" }, { "key": "update_mask", "value": "discount_percent" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40d6a13a-f34c-457e-9935-eda364ba53b1", "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": "cf82ba29-d26c-4dab-b894-3029285edf9d", "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": "9c89c9f7-3d50-43a8-9a1c-8e1235b8067e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b29555e7-6f00-47bf-9086-45b447e435eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c071cf82-ac85-4ec1-99f2-5d801e4059ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01349aa-7445-47db-a852-4fd2340d1f0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cad2ba5-f041-419c-9e9c-06aee7b43ca5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74b0627b-0210-4100-b3f5-f1b8ccc52220", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9697c390-bfb8-446d-88f5-7679e85b7854", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8d0f9c-5431-4478-8429-46c10780fcb8", "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\": 4327,\n \"message\": \"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": "df66e6d1-5032-4e0e-8d3b-9f5070c0c64c", "name": "Company", "description": { "content": "Company endpoints.", "type": "text/plain" }, "item": [ { "id": "25ba8247-41fe-415d-9563-1085eeab3574", "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": "c515cd78-b3df-475a-9476-4d0cdbcd2914", "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": "1a041dd3-ebc1-464e-8558-e99b353018af", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d545c16e-79d8-49e3-8052-ce3e7c9f8963", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d7d070d-2001-4a77-9630-622ac6d8ba66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26bb4378-2ef0-41a4-a57e-56e43a0259cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1184be18-b24d-42cf-b53e-80ab6ab7c67d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f18b628-d252-408c-8355-b9cc7dc3ce80", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad39fc2d-dd7c-4961-bb71-8727c22b5a97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93f8730d-d717-4d3a-a5d4-0e07bed2bc6c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5752b479-d02f-4768-a03c-1174d81ef7cf", "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": "e6f40fcc-cdb2-4678-a333-edb1bdb1de71", "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": "95d6f980-6deb-4a5b-af4b-bf61408d437d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "654a48dc-4250-475b-8fa4-3d0d0d9f9549", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d41485c4-a9e2-463f-8a6f-0a0bc9d2a8d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c428e6e-2a8d-4b72-8c60-e63bc6b5a271", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ed73da-17dc-4fb7-9fea-f7f8ab51aa74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "320e205c-74f0-4386-88c0-9204e66e4f7e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f14ad778-765c-4744-8555-c2688aad351c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d09e065-dc08-41af-add9-40347dbdbf9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99b5672b-f50c-4583-9aee-c0df6dbe365f", "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": "b5cf3ba5-9366-42e2-975e-f6de71fc0a2d", "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": "ed285a7f-52c2-4229-a093-c95cf0f770ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c949352-a21d-4401-ae04-4e8f1d5083c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6ce82c7-fcfa-4d1b-bb2f-a4b5860e86d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61acb2dc-c430-46d0-ac56-21a3faa1c6b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ad383a-04ce-4996-83e3-79a08cdc5803", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24383c4-c886-485b-acc8-7968da195b2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b51fbf1-f7ee-4a50-9fc2-f1b2a065830d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60bdeb70-eba1-4029-8c47-5881e1a5a575", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4da5821d-cefe-413f-8ac9-ba3df4aa5dd3", "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": "944ab57a-3ce6-4fd7-88d1-0ddc589f2133", "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": "c9893940-25e8-4c05-b38a-298565ddc9c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04f316d6-9c43-474a-b277-3a7f255cba45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "621f3bd4-3910-41bd-bd74-72c6ef545491", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97464740-661f-4e9a-87b4-d29a2990ca9d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29e06ac9-5ffb-4424-81f3-a39ab92d6710", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "661f5959-a928-49e3-b551-87b0fdee242d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb0abac-b680-40ff-b527-27adbf20fae7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e0bbd65-e059-442f-b274-1e7242ae968a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "940917fc-fe14-409e-aeae-067baf646f99", "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\": \"DROPDOWN\",\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": "205c8f84-2872-4bc0-81db-9e833e21b5e2", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4920acfc-0d4b-43c4-aea6-64e550f3f7c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f701a2-98b4-47d9-9cf5-4379fc1896df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ce198e-e4bd-4851-b56a-6973957fc759", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf7e68a0-b392-40f2-9b5c-18232572c731", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27485d27-9fc5-4afa-bf6a-d69ef7ebb52a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d37148-61e3-4a98-8b85-42da144f937e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a62fd7a-d54b-4079-a91e-172701f3709e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db5308cd-facc-4e22-bee5-624e96acfc01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9fd8065-efe8-4738-ac94-95d8d34cc152", "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": "8220238a-9eb8-4d6a-bacb-8f8b55ba851e", "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": "946cc714-8a91-437a-9cf5-5e9f7f5e3468", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40a9d1a4-7452-4273-9a84-1c10dab468fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7afc554f-6f63-4977-bd54-01f2697241b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb0b62ae-bc82-4cb0-80b2-4e3090fa93e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c471b58a-62f2-4202-a105-6bc94500990d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ae4b8a5-ec98-414e-bec0-167f4db4de24", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a23f4a-7f97-4330-a318-8002b6653ea9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa70ffc9-f8ed-40a5-83c1-ae5a08814571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc9139cf-ea10-42cb-bf2c-d7b515f3bc88", "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": "2d445695-29a2-4066-866d-6f141d690d15", "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": "1845f0fd-2415-4737-b698-2b6c0eab8378", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc4441d3-235c-475a-a19f-fe7d43a15827", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbc836d9-6a83-4ce5-8c72-1ce96e3cb6a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10204a25-0729-49bc-85f5-b415f8b37c7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "633c2d4c-c4a0-47c0-9e42-a604a6ad7fa4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da3ca00b-b8b2-4a18-810d-f34d475cdee7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a87ecb70-bb22-47d4-ade5-facebf0fe199", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22c36af5-0c76-4f95-b4c5-728f84d6c521", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bf97edd-5730-4fdc-aa53-614f2876eef0", "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": "c6504f33-4242-4dc4-b461-16545b70b61a", "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": "6a3eb510-8c47-4445-8c6d-acc9b418651a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ca0160-fadf-4883-ae21-0da88e72df8f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93756464-8492-4b11-8e10-799ef771bbc1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02cc4052-358f-4d8b-bef6-e935e18a1610", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2ad374-bd96-4a45-b853-ab8554b46747", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7197dc91-d4fc-4ce1-9c2c-824cd31acb3a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6203b566-53ba-4bd8-bff5-00e08347400e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb9a7ae-c1c4-49cc-a97c-dba84c0dcded", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43d7fe52-feaa-4ad1-a060-9dc98be636da", "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": "f1561401-e938-41fa-bd68-964116eede7b", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5eef44-cb33-4c24-bf1a-efd37d7dc400", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2febd02-5f55-42b5-81d0-e6cfba9864b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad7d238-e72c-41de-88f7-b25e8c1ec797", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96f1adf1-43b1-472b-96ea-8b7864aca813", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4117cf18-5e1c-4897-8161-de4a1972f7a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd5887b-1d18-4606-a9e8-2cafc3b00e74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ee286e-9ce7-49af-8aaa-a9513dbcf70e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49928014-5632-40ab-b6f8-5172e4c2935a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb7dd4bc-e36e-4ab6-add4-704d49fe7d26", "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": "e396f7d3-f205-4472-9679-474a801381dc", "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": "87c944de-c3c5-4647-be23-04faeaddd20f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be1d2351-ab46-42b7-b855-5cb44741db58", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dda2dd22-6115-4e97-b0ad-45163ac0e9b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c25ee8fe-f169-489f-9379-1fb0adc26574", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "700f0b54-dafb-4843-a221-95818fa23fc0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fef4b9c-2e44-47cc-a666-5d26cbc770a6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21cf5015-510c-491b-9641-efd6e4ad1f3f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c54ac21-20ed-4d10-8324-58b648a3dd1b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e83590e8-3f1d-4f3f-9025-ea4c9532ae10", "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": "076c24fb-1d44-4733-818e-c85454155450", "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": "b4023ef6-f100-40bb-8294-94f55f691ffe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f05280-5115-44c6-8ba4-d77eb633c5b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "574066ff-f01f-4b48-b336-29bbbb4f7f7d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd0943d7-6e14-4d36-ad7b-d6afc76d15d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cc9fc7-b68a-4d03-9e88-0daf95a073f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbebaa60-e77e-49c3-8736-f654f13a0aa0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1595c87d-c1d9-40fe-b611-3999588c1c67", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba6ad63d-7df5-40a9-a4e8-fbf1d0c79606", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86ce475b-e2c9-4040-befd-5fc555a7eb13", "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": "email_address", "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": "account_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": "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": "d15c0abe-1eb4-4ebc-8b1a-cb00a589b47d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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": "3d76f6a4-5f61-4af1-940a-1ff9bf12d0e9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b72629-4960-4a77-b655-0ef632ff2105", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c999a3e8-e6f1-42ab-8565-bb78e2ee884d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dacbd34f-112b-4326-a444-7ab2a63c2dfa", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c57df7f8-e400-4c0b-b839-425a2674e9ed", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2836ec9-8bcd-4092-9a29-516fd4676290", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b9e8e0-d735-4b90-894b-bdb40ae15be6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c8a7a14-70ef-478c-be74-ab25839200ef", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "created_by" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a5c7a99-749d-4dd8-8450-2ff64d2b0ba9", "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": "7b4c6c52-c6a6-4ebb-9796-da5150a8e5e0", "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": "b50a5b03-0b6a-4a91-ad46-4e42a8a25e1d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5234f6a-73b7-4ae5-8760-403919a629b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "949e2119-b99e-43eb-b109-3fb7cb4d95cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d34215ea-8aa1-4a96-82fe-a3d769d94e1f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b85fdce-2f82-4196-894a-68c6aea37258", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33f16844-d2ee-46c2-94ce-0c385809df56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc68743e-4fba-4acf-a793-86af84b7eba7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca642ffa-0159-4b44-be10-818438a7d6da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2373d298-d302-49d7-ba1c-8691b3cb5c3e", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "3ac1a469-2479-4980-b62f-c53905214a48", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05f6a4cc-ff07-482c-90aa-ff9e1638ac75", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6698848-46c4-40a1-85f3-fc5adafc9ca2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ff743aa-e5f5-4f93-9740-b7da4e663d06", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b52496-3fcf-4184-a3c3-7194dce5c26f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de813303-9525-4258-8264-e5625168cd33", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdcbe6dc-ce79-46b2-8b4f-d2effa65dacb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3147c535-3be2-4a85-a576-baf8aec4a134", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a57d5b04-c22e-446d-87e8-82259c338077", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd748324-af70-41f4-9f17-456223f939fd", "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": "535f69ba-9077-40d3-a2f0-94fd11beea57", "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": "f7264b75-9e07-4de7-af36-62e07a6e0d2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de223267-9fd5-4642-9de5-81f845bb6106", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343a64c3-f642-473f-bacd-d2b910ba8924", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c4fedd-7715-4de8-86b7-dae5454dc222", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16eb2d4c-0781-4072-b15d-9c6c2e85f0c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd28fd90-d28c-44ba-b4b0-e02e3ae505bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "530aacfe-63bd-44fb-aedf-b90fcd163a2f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8bccf6c-0f6c-44e4-80ca-53d6408a1ccd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "442dd885-e34f-4f32-91cb-03d0e1ab7aff", "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": "ace49d2f-3d52-4322-b29a-77c66cad437e", "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": "0845bb6e-a29b-409d-b1e1-6abf5a9ee68c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74662a9a-4365-4617-a68c-feed026d1f2c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f1fa21-7e86-49e4-bd83-f9313ffbc4a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "169f3e87-4fd3-4dd1-a782-d0b9f4e09801", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d564cde-5b41-420b-bd83-29bcb53479fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4544348e-a90a-4251-b443-e1c924b23dfd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fbda4ae-d5b0-427e-a7b3-d52b9f2e5103", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc2096c-681a-46d8-b1ec-5d78e09547ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07d39eff-a48f-4b03-8944-96fac97c4e4d", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66a1bd55-e494-4425-a250-27f1040a0a39", "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\": 2514\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": "affb0eda-ca2b-4504-9551-1eeba628590e", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab6cec8-fd50-40f0-920e-cf28a9d87ecf", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6682f73-0544-4881-a8f6-a2413542ed85", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52176784-2c55-424c-bdba-39651a1f538c", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be29e347-9709-45de-897c-c4eb04482c59", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09056bf4-eaad-41c7-94b3-c889d67a5f45", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd86a49-fff6-4e9d-aade-63a84f5e1fd5", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "511acf28-878d-43ec-9745-127cb3ee182f", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7b4eeaf-9d11-4695-b3d7-6f58c3107cba", "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": "0acddff6-554f-4aee-8f7c-ee7def610b0d", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03e37279-b95c-46df-8bfd-bd2e3e31c6a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5e9d547-3bda-4b5d-bd05-e15b7efe1796", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f24ea2-9cd1-40eb-8954-98645ffd2679", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fd132b3-0292-4162-9d8d-020891f31733", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35614b23-7170-4a07-bc9c-055344f836db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4de95c5-92ce-4aef-862b-3b97f6aaf12b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1ecf682-6b99-41f5-9fb4-eab7b7183fff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a8ac38b-59f1-4a6b-8bbc-0f4fc6f0a22d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc2ebfcb-7f19-482b-9803-a76db9f9f1a8", "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": "2bbe8ed0-bf74-47ed-b83c-ab88854d326f", "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": "7570f811-b7a8-4370-bf33-f65c25396e84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe78f128-cbf4-4da8-9a0a-9e14630252a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c03d5481-c9f3-444b-ad7f-0a57cd174b3f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7bb16cc-bc1b-4b89-aa39-df004d747a11", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321e0548-e832-4eb8-83fd-a4550d9cc2fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e408b55-b170-401c-a108-69ed95b7afee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93ee1f7-ea4f-41e9-9011-47921ddf9dfa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1386cd6-ae25-42d1-968a-dc3241d79c87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "250d92f1-82b7-4b0e-8713-22c64b85ad88", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa89b635-135b-4b9f-b8df-425ed02f9167", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0cddf7-47a6-44f6-8766-1ae7d114343a", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "705c9faf-46e3-4c53-a009-46c86bf799da", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "382282c3-5fe3-41d3-90fc-cb97fca333ee", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d009219-ad5e-457e-bd42-ee3da52ff9fb", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a683f4a0-9420-4cf8-a421-fbb1ce41f6c8", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "290257b1-f6aa-4ca6-a83a-253c3268b3ce", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6e42f3a-c443-4161-8b57-2c4db481ce25", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e73a45ca-113f-4bae-9776-87c1b65b7803", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ef637f6-11ba-4637-824a-2908ff2030ff", "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": "a62ef730-858e-4a73-a2fe-a5497c4b9f11", "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": "4c5ad3aa-0f5c-4ed2-9a55-ea7600b5d99f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24834004-ebff-4130-b3e4-023d8d148f52", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ca89be-2fd3-4973-992e-1cd3f01f8034", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7e0d002-9f01-4471-88fd-29d1847dcc2d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d582b3-2582-4328-a64c-4203c3469431", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a415fdbb-0bbd-497e-bc49-aa8a0982bede", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d219da-5550-483d-a159-cb7816e3ec08", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c898a649-f709-45a9-bc9d-cf48f381d9de", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "451419c0-8467-4a40-a283-094f01dd2fea", "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": "be071027-1635-4f3f-bfa1-e05af9143f79", "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": "7bd25902-70e7-4ca2-a2d9-27b3340737e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fa90e05-9b39-4f63-a206-d40fbe035d60", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9686e647-7183-4051-bfa5-5fd5975fb937", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9444e5-b30e-41b0-9afc-9ec224487950", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41ed0bd9-5f0b-4c7e-ba66-90520f0c6a3a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2271ade-d822-4dbe-b86e-8d460f436331", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e54250e1-b4bd-4ce5-9412-a84e31ab8d27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f7265c3-9e58-4c1b-8d9e-9d9b86933e68", "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\": 4327,\n \"message\": \"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": "15fb2ddd-d6b5-414d-a01f-a7f45e78dae0", "name": "Contact", "description": { "content": "Contact endpoints.", "type": "text/plain" }, "item": [ { "id": "025ff6e4-ea9b-4d16-84f0-003573f90112", "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": "3ab3127d-f0a5-4e30-a746-0d0988a94739", "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": "6eaf4c8f-aa3c-464f-b72d-11c7ced72058", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1550be18-8f9e-46e5-9aa2-c89da3b9831f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10741ddd-023b-4fde-9a69-a16a1df59557", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "261cf154-bad5-4f49-90ba-e1ce3d90114b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc68f19-a298-4950-a2b3-1dbed3b9766e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81c15e9c-63f4-47d9-96f1-853795a55784", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ff73f2f-1ad8-48ad-949c-59caacd7bfd6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb39bcbe-d1ae-49e8-951c-c43646765238", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe6090bb-a770-4c78-882d-dc035400f5e7", "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": "Email", "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\": \"APPOINTMENT\",\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": "179cc6ba-2749-4fda-ac7c-d180200ce8bf", "name": "OK - existing contact updated", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": \"INTERNAL_FORM\",\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": "28d63829-f64c-41ae-9f1c-d5327e9cfd22", "name": "Created - new contact created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": \"INTERNAL_FORM\",\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": "a07cb244-2531-48bf-a912-86a28dc3553c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afa7d5cd-7d98-4d3d-9d26-d9e6bb540281", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3042756-940e-4c97-a902-a49dd66fb144", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69ffcd85-8200-4a48-a6a3-06a2b47e6e15", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bec5cf23-8608-4a91-960b-d7a489a567ba", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0acb2e6-b1c7-4325-ae36-98c78a7e12fd", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddad8592-706e-46e8-943b-07d497b16177", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b11eac01-d4f4-4666-8799-3641a69ab1af", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "Email" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "750a6bb4-6d72-4462-af27-519c248dca6e", "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": "1dc73f3d-944d-414e-b397-2ec467771f9e", "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": "18c2632c-1a1a-4872-ac65-26ed51e7b8f7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d76b81-ec4c-4e0e-bd68-c7be90cf9395", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c41c21-cc4e-4db9-ad30-f58e75c3a558", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1cdef48-ce73-4e33-9744-1270987ea9b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6801653-61ec-4746-8517-04d8123c86e1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb3ac05-8500-4818-b3a6-17bb3a74608d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cafdbf-0779-493b-9d86-b7a93a7f8322", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44ff3ab5-1a22-4373-8d2b-058d74a391cb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d140006a-98b8-45aa-a5c8-77d0252287ff", "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": "d6cf7859-9297-4686-9687-6d5540e165ae", "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\": \"INTERNAL_FORM\",\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": "f7906617-9b9d-4935-8c06-4e6d1f00f98b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4032295-1c06-45dc-9004-bc2b9fa2cb9c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bab43af-e708-40d7-ab9a-6eb7bdbadf88", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9edd8907-50e1-4e42-b035-7979cc2e0497", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8efeb46e-c5c2-43db-912a-1bb5cd4540ec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8483062e-ecc5-4302-a3f5-0975089e1b03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb02a4eb-b27a-4aaa-a3e9-056229f15533", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7f3b3a-be05-4e4e-8746-c901304ffc77", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb4030a4-33b1-49b9-817b-4f2c2b041bf0", "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": "7f49a83f-779b-4ddc-a81f-bc0232c693de", "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": "55ed33ac-db2a-41cc-ae86-30fe099c2c12", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95051a40-6b20-4a0d-a24e-5ba2c4618211", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6264a96f-308b-4e88-9443-05f087bc335b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a9f85a-5f87-4fe1-ae55-b7f84db34a85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db5d5727-27f0-4e1d-a3e7-dec46fb4094e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e367f751-2b9c-4750-875f-13356b38fa9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c56a8ed-e1fd-49d0-bc78-959d575e976b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3082e8a5-356b-40ff-9ca1-84840b5dc01a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2041ed6-31d0-4825-b48b-b1951ea3e58f", "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\": \"DROPDOWN\",\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": "1e3d655d-ba4a-44c0-955f-316630d26b53", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbcfe1cd-113b-42ae-aafe-8876c26b58d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74207859-dab8-4987-b5f6-cb18e8f091a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e6c708-9097-4fc4-86a1-37eb6ffe580a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac065607-5795-489a-aefb-685dd87c374e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7539655a-e0e9-48a5-944d-d25f5136114f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f23f72b6-d301-4078-a140-fb45d3838ef5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d006913e-6c30-4f20-a07a-ff4dbd2c78f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bcbce78-a051-478e-9e79-4f9b81e76a67", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2350939-a4c7-4f21-9f3f-2785ad728003", "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": "391ca182-9ba6-4551-9601-6dc89dca9800", "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": "80679516-d932-4dba-847f-2ae8dcbccd41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1c2ce43-ffc2-4dc4-80a4-a1fffa409b8b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a92121f-c1d0-46dc-b62d-a60d1edc0219", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b03f1814-23e1-4960-81ea-db1211c6a628", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81586ae4-ef0d-4024-9764-66df1f94526e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74957144-4cda-4172-a900-aaa4a31aa373", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c4a84fc-c4a3-47ec-ada4-ec530383ff14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5435d5d-0d1e-4ece-9ffa-9ae4170584d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e18087f-9654-417c-8267-896d272df2da", "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": "0b7da648-02c2-448d-9b25-6b9997aa2801", "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": "a997b4c7-8304-4a0e-b830-8f1919958c14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ff225d-2ac8-48c5-9f07-103e9a0f5d41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70158a9-995a-47c4-8b64-ec6c5f369728", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c03b26ac-51e8-4f11-a23b-ceeddf883de1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c6b74bf-a109-47e5-83a8-3beb732d3d3c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d09cb8af-aec4-49b0-83d7-d7956cc27ed2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac4ed694-fe1a-44ee-b27a-67ce4ad663ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea428383-1503-4ff6-bcb3-f4a6b78a2b45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5598ee7-4e2e-45a1-83c2-aa6c55c66ef2", "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": "9a25bc10-fc90-47fe-9da1-b5b1d8cc9be3", "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": "f60dff64-9253-485e-89c3-67a063c96d01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f092d70-f175-48e4-83f4-7c9771d8bd14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e67824-725f-4d46-8339-bebf80339804", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea488bf1-4a64-4f5e-b5fc-02c7e142619e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98dd66fa-2d93-4794-9f86-d3600f94a25b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671b0d6a-6fee-4c8b-9788-2da39817cf2d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c64294d5-991f-4f3a-8dd4-7599902be5b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc7ee9e-61e5-4268-8692-f4317d9425e0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "752a3b8c-8251-4713-a239-d2d2e5df7945", "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": "b105f36f-4df3-4e0c-8c70-e352e897d515", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "733a6c49-597d-4d9b-bdd5-266676da473c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249c17ac-a0d9-42c2-8d6b-1f6e57f9d7ed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d2f7fc3-c65b-42bf-89dd-0884c48a6763", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e26d4fd3-04d7-439b-bd03-7fa7e93e7302", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab6bc14-da8a-4ee0-a49c-5315fc2c0fb1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3189538c-b890-4d6b-8701-d356fea3a212", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e100938d-d592-43fa-b6d4-c0ebae5e0fd4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24ff9e4-4ed2-4e7c-bead-44c4786e24cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddfae653-fa46-41e8-a0e6-e370f709688c", "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": "5420d1db-606c-4a6c-9989-a8ee01031614", "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": "213c31b0-a6e7-426b-af2d-d886551f063f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa63374-0e7c-4b56-aaf7-c74ba5af1a88", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b95c2ec-dc91-464d-91c3-d99f251039df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e390388c-f3c0-456a-ae28-2d57fd9f249a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b42718-db3a-4863-a97b-8bcdcbd309db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32230543-ac3a-401f-b15f-22e7d5a5d197", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79cdff06-1c38-405d-b94d-bbfed92153ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9768487a-b375-41d9-b9e2-4ab3a3021519", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2937a78b-aee0-4ae5-8a42-cabd921bc907", "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": "8f68fb78-7739-4e3c-a527-ab85de9851a8", "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": "0e696690-1932-410b-b62f-5e905520e9b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d844cfa4-b321-414b-b8d7-dcdfcf1c1c08", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9c8b3f-b554-4009-9e3e-610f490a0d8e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e74553be-7477-4e07-8277-9e3a9f371fdc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "645a5524-8347-44e6-9e64-c6b0ab6c87db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83338176-f687-49b2-8ff7-13b734367fda", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cd9799-353a-4cb8-974a-3b038930d5c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84559c79-19c1-44d3-8de0-90cf5943c9bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42b20561-fff1-4f4a-b096-7e7210e4ebe6", "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": "8a97971f-a6a9-4f47-a317-594cfb7656e2", "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\": \"INTERNAL_FORM\",\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": "f2072b1c-5e1d-4f3d-85ac-ce26398d5e02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa0305db-acd2-4986-bbc6-f9305bc77e7c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a524dcf9-4646-43e6-9a6e-2db5a1a73ddb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5590d55-302d-49a1-a585-3097d2210988", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd7ca76-ece9-42bc-9082-febb845d74ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f50538-a0c2-492b-ba36-c429d68ac3ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f474e8a-269e-4581-b66b-13f086966de4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "036067c8-14d5-4d54-af1d-a944c7dc4d37", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7b8e381-ac38-4485-82a9-fca68de10f75", "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": "735798b2-c05a-47df-b8e0-ff099c4ee2c6", "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": "823ce960-9ce7-4eb3-b7b2-5c084bb044b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d95cb7-a2dd-4dd5-a6f8-c40b2db90ae1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfb6eaca-f86d-4136-a903-8e46d18b4ee3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93aae2d9-e3ad-443c-9b6a-7dae2eddd7e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236d08e3-b2a1-4c16-b215-79d0572a4903", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10cb3646-3ac3-4507-a055-47799c07a323", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1420c88d-df62-4384-b2c5-0315f802dc6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53337233-1e5f-4d9c-b098-66f198f6c400", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b70789c-a3f7-442b-beb1-605346451b8b", "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": "source_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": "preferred_locale", "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\": \"APPOINTMENT\",\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": "baba28f9-c47b-4a50-bd58-d2e0ab7adad7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": \"INTERNAL_FORM\",\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": "14853ff1-6dee-4a9f-b1ae-7ec7d7e91afb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b36b691-7b39-454c-bf2a-93ec22ef05f7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4d7443-8f55-4ae6-9bf5-c655e5099854", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9637077-7e64-4eec-91d1-f4a87bae42ba", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be84e411-5b0c-4773-9b1e-56a24e1ed9fa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a2d1b67-88ec-4a03-b920-a0d1be303ec7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecf01ec6-2b4c-41b1-9679-3b7e2cb359e8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52e19bec-23b0-4f56-acee-d85ea6b03112", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "suffix" }, { "key": "update_mask", "value": "owner_id" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b152849a-11df-436d-8a22-9d462e546ec6", "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": "c6fca34c-a31a-4440-b428-e2bf2be30951", "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": "07e261ad-b558-4e8e-b554-b878def1d9b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "575d74f8-8bef-4a64-a477-cd89d1b017cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6d88396-f854-4204-92e9-50601aaf05c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb344379-ea82-42f6-86a6-37c253fe584b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321bea59-b057-4ee4-bea0-421ab9f93723", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ed03a0a-7058-4770-acf8-876d846fff72", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3072740-a771-4db4-8717-73d26cf8d558", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b1aad2d-67d1-4418-adb0-d0a8306516b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09ef76da-f14f-4646-980b-76d8046ffd4b", "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": "460decf5-2141-4607-ad8a-e2d4b598c0c0", "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": "82b0a5ed-c59f-42a7-b58b-3b9c1ca66a74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85ffcab4-4315-40a1-88f4-48c3234943e5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "125d70aa-1276-4140-95f7-731e0a46a489", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49faf8f2-a6e6-44ac-bc6f-e75d6a40ccba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623c3dc6-f08e-4c0f-b0ab-26987d406ef3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d60e72-6b67-4328-bba4-d20f9c32665f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62248ce-a3db-411b-ad7e-8d48990ded42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3909c12-db14-4d0c-aefb-3c10e2405170", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eed6bbc2-586d-4ff5-9275-58a217c53dc0", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e4d134a-cd64-426d-9dc6-60ce6a8e3608", "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\": 2514\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": "02a05728-a28e-4d5c-bba2-fb7bc0b2bf38", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7cd18c4-ce4a-4dcf-bffc-375e61b75171", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027a35cb-ae38-4108-b01d-c3b79792a7c9", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4c616a6-8b24-4a76-b055-adb17f8906b9", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "861cf109-4824-48dc-bc50-a5787105033b", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f67b5f13-7ad5-4726-a227-90055a06560b", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7394b2e-175f-4f80-a6e0-9e1a75723313", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d0cd6c-6d86-47ef-95f0-089c19df6ea0", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fabf237-c3d6-4ac8-8b95-d50b54189d99", "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": "ddce6dbc-4a60-4f48-b79d-477a07d3746a", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6d8a76-7717-4b48-bd5c-c189e1cbeee2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023e63fe-8cf7-4076-b9a2-d3fe2153975e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ea3e611-faea-4749-8e46-88a0e1fb3497", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d853b66c-f554-4bde-ae85-e7e03af0d58e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb44bdda-8950-4160-ae8b-59a842ba91bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11a50473-e16d-4ea7-ae2f-aa534ec0317e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5650d95-c931-4676-8b31-72e6d42fe2f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4553cb7-f4b5-4efc-9a33-90c3251e924d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fb6076a-795a-4017-8557-98653f7f939b", "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": "c2c93534-e7f9-4794-a311-2428483ccad8", "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": "18b098b6-4e81-49ab-b029-d47353d92e34", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89ea58b-e166-48fd-9365-017a2351c17c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "856fb966-e7a2-4b10-94c2-69ece2cb56ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0527ef8d-3bf2-43de-9583-1fdfd09cc012", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf89e2a-f56b-4963-a8bf-c6f2345221fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c117c4f4-3545-461f-99dd-3c251fde17e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58a76ce2-1bbe-4d22-87eb-e22a9f4f2033", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2335d780-d2e0-406c-8dd1-34de6f34d4ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81386dd5-c3a2-4d3f-bd85-4a0578e68f42", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dc5a26a9-9fdb-467f-b166-9ab8d4988cf9", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4fa20ea-7797-436b-ae1d-18d6e6aab6d3", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02013cca-caef-4b9f-a41d-822a8af86528", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8bfd72f-a354-4394-88cf-e10ee9ddae68", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1a9025-dfc6-416b-8b15-a2dd0ec1205e", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "facbd19e-30a4-4eb3-880c-22e63291ccb4", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eded19c5-b1a9-44a7-873e-ce6d3b37246f", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee2d9f6-a798-4f6d-8b70-fbba8c217466", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cebfa9aa-0df2-4712-abcb-c2dffff93123", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a37166c-1834-43bb-ac3d-f3c4816ff5ef", "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": "903de4fe-b6c4-4aed-bd36-ca940144b536", "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": "03d28d59-7d9c-4ed3-a8f7-792a255f8900", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "591d76ef-b280-4347-bf6f-77d8ab47dea8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecc1aa9f-4f7c-4fad-8259-2eacd888868b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c8b06ec-4f0d-4e61-b32e-49dbec2ec439", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2de5f4a6-18ec-4b9c-a1df-9975cee45702", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5854bd32-a8c3-4e97-a292-4b79f78537ed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ce05fc-ab68-4b8f-8008-7137ada5b644", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f54576e5-8078-47a1-bacc-70ed86db6185", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6821e98-fbb5-44c5-8b3d-dbccde80211e", "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": "0b79d4d2-7d02-4cdf-b9be-f900e1f11095", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Spouse\",\n \"max_links\": 1,\n \"create_time\": \"2024-01-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be3d6a3-7325-43f7-b773-ce2186c20e2b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42742e65-803e-4d08-a315-b30201fe6fee", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fedf830-ae58-49ce-9955-b6459a9b0272", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7623d9d-6929-4fc9-b1a8-a45d644dcd35", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73d1fc82-9db2-48d8-a42d-60aed28c8b1d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d25ec4a-e787-4714-a75f-35af566f8a6e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9d74ead-126d-4e7b-9d50-056eb924bbb6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4f6af72-e985-41f9-841a-8632f0fa0556", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "max_links" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4beef949-1d5d-46df-82c1-4d379d1399e9", "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": "f59f6a9b-9ea6-461b-b125-7067d67d2dd8", "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": "f99249e3-b25f-4bf1-a65a-011aeee4d363", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac201e0b-1b18-4a40-a5bd-dad3d11fce3d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c35d15-1d8e-4c6e-ba25-043e37c16f85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5587460-88fb-4c91-9502-c4c7740b437c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "166a38a1-593e-44dd-b341-bc68c3609fc1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3717544e-307d-4e8e-a0c7-632e15acc3b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe9c3cf0-62de-4c09-a8fa-d8093a00c20b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443bafd1-28da-4ca9-b6c3-e5da1fefa6c5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9a4a1eb-c6e8-4a10-8fca-4e9b079ec4cb", "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": "1af858a0-c3f8-4f31-a49e-b788d46a9d32", "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": "0da29ecc-bacb-4499-a98b-b9e5b7a41f9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67dca751-8a74-4b30-9b28-40656336e0e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e4b844-6ac6-4558-8378-6d13a40f90d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8eaf6c-0222-45b3-9a1b-f9ab5edb325b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2154a44d-9ac6-4c86-b9e3-a69cf468fa9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb992d36-48a3-4b82-992d-d64ba01234d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc59d5e2-3d9b-4ac4-ab6a-8dad2d45f7df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b4cc8f-7481-4466-9fcb-b4f88a772ea5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c0aa9d0-4566-40e3-9a38-d76900bb00f1", "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": "c727f487-7185-4825-aa6f-20d71f3aa491", "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": "6f48c52e-5dfe-453d-9b7e-e0e920ef2634", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b8dcba-4467-46c2-b3ef-f1edc780ef01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b28a43d7-eeaa-48e6-bc98-74874c5543e0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b19921-abfb-493f-bd7f-d690e3059745", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a22fad4-79eb-4699-83d0-00d41339c6df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b731d9-cf25-4d36-9ad4-f62735e80b02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c105cd4-4580-46a2-bb64-f19e39aad5a9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "556b3d73-cc78-4763-9ee2-b65c0bb7db20", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8366c5d0-1d25-4b86-98c5-af8eb367ee35", "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": "b3c2bfc6-a457-4009-a6e3-78912f75fb89", "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": "294ec46e-d54f-4e61-9cc1-b5836e464393", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d3d47cf-fa0c-4071-82f9-c15845d8e6dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d066e5c0-495a-4787-ac11-44002103929a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e29c43a4-fbb5-48f7-b447-f55379b1bd72", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9bea78-6fba-4a7b-9a6b-d4cc51f9d22a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "368651a4-9464-4af2-8f91-0a85b1dc657d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dd976a6-3a7d-4e51-a95e-be7c69e98571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cf3f41e-9c16-4526-9cbc-62539756a2b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d65bd507-5c0c-4cf6-8621-a6c08528ab23", "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": "b8a0ce35-6150-4315-b9d2-08df29694f8c", "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": "dae5934d-27f8-4cdb-9e33-1c8ef177c898", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3083278b-7d95-458e-974b-8a7ed208cf02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "078cbbd2-12e4-4a25-b439-2cbd65ffc131", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b01ce92c-6aaa-4eb1-be82-8218674ee768", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baf86f6f-e572-41a7-9a0d-be1359ef44c6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdd66a85-c3ca-4a01-a564-0cb93a8a6052", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c848f200-8dce-4d28-b3cd-73fb7474cf3c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3df422a1-6bc6-4a6b-8b07-dfe15a92a74a", "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\": 4327,\n \"message\": \"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": "ed6858fd-4df2-4487-b1c0-93b5be6290e0", "name": "Email", "description": { "content": "Email endpoints.", "type": "text/plain" }, "item": [ { "id": "47e1d5fc-4164-4c89-a3a8-e0f51b79d4e9", "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": "3173c52d-ec72-4d6c-bdec-7a98bd6bda4b", "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": "e9618e6b-313d-4e29-9157-6af10c2955b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "151a6699-1929-40ad-a47d-acaf99055079", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53697fde-15f8-4092-a31a-029454087aaf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29f7c84a-8b56-42ad-8794-d06b0df6ab5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "849489c6-e704-4e8c-907e-e7fd48a7852f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597e208c-c734-459d-9203-b154ef9c1cd9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "685c0812-d3dc-4304-8d7b-621a3cae4138", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88163322-7ff4-44ac-87c6-54e9def3ab2e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c093f354-ec61-457c-a3a5-a6a769d2722d", "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": "2b19e1fa-e7e4-4cfa-a90a-2a8712da585a", "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": "abcba6aa-39f3-416f-9b8a-e73a565613b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58ed046-9ecc-4151-b39e-a4d4ebf3dbb4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9edfb3e1-a570-4f03-80f6-4b2be8ef49c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d28c5789-617c-483e-ad74-8e6d596d8c7c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0acf30a1-6887-417f-b271-7369fa9a2b5c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c1efd19-fd25-4f85-a0e7-233dcda8f7cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b4bbcd9-45e1-4789-ae13-a221d570410b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a7051f3-e644-49ec-bf12-e44ad67f3b4b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a11597e8-34ca-4e22-86e9-cf0dff1e9ed1", "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": "d164ff76-b089-405a-809e-28e68097fff9", "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": "1b0e8a99-23ea-4d28-83d1-6e7b1306a032", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2842af8-9264-4d73-8084-b6e72591dc0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01620f39-9198-4d71-915f-f762ff89db4a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b6112e1-5a60-4fa6-8e05-8e4d4fdc0c85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d67684cd-8494-44ef-a21e-da0143db63e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86629b09-0393-4c8a-937e-fc9d1674e0c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd9e0b5-4c03-4d98-bbbe-67e3548abf01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bec2e20-cccb-41ef-81de-62c930f041ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b82d48fc-5c32-411f-9316-32cb60ab795b", "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": "9b573591-1c92-4297-a844-c3884651831a", "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": "83449b57-6f59-4941-99c5-30cf85ece27e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e5fa6c-aa2a-4d29-a130-d4e5bfbda062", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6610ac0a-f6d6-4a60-ba6c-536e977b5cdb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a032dba-40b1-4116-a8e5-07b4c8a1c369", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f187ba31-7fd7-4976-b512-1bab70bbb5e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c26c602-33cf-4f07-a100-f625fd93f576", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c47a975b-d026-4925-9cdb-d6e69133b659", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f391fbb9-a93e-4d85-8c62-14f2db2cf8ef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b12ea82-c8ac-42e1-8ca8-e94cdffb32a7", "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": "f79ac4a8-252d-4d70-9931-beaf41f933d0", "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": "bf2c406f-f199-4d99-af3f-eb0801fb04c6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee791e8-bbc4-4bdc-9116-cb3ff024c5eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5834d1bd-9fc1-4f3d-b6fb-ca727e5fb3a0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd2e1de-2b9b-46e4-acc0-d70106d37936", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fada95c6-51e7-4fcb-aea3-906ee417d0b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4586dc-a150-4b9f-8de3-11951dbdcb6c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2ff7119-1353-40e8-abf2-924b8ed42884", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e61f2d0d-69e0-4308-b5b5-fb495d5c3233", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c6df518-e5bd-45d1-a07f-55bb5fb93d75", "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": "55949a6f-0011-4508-8964-2772a93b39c1", "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": "1bf38dd8-5cd7-47b2-8906-4b5b0e8b1ef1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e9ada0-dae3-4d31-ada5-ab9706279c82", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b29b5a09-acdd-4cb9-b554-23dfb31717bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb3c3f8-4b1a-4366-82a6-dba3934d6c6e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b723e8a-0e77-44e9-8dce-9c1ff382d9b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b43f68-ef7d-40c2-8a95-e3b9047f4e5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bab640b5-8fe9-43d5-8745-acdfbe6ded0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1a42df0-0504-4341-9517-3724acdbc08b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73e197e3-8d48-47b7-834a-1dbc2b323a85", "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": "32c49ced-0db8-4580-a589-78996a37ca34", "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": "62951004-09d0-4116-9a05-906c2527ad27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dbc9124-2259-4361-bb0c-370c628b112a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502f5650-24fb-4393-b8c3-c7d0946f1333", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2caf15a4-d813-4fb7-927f-f59bb060145c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ba92707-66a4-432b-9c79-24635c32d83c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ae070ab-434d-42e6-b861-397f1aa02515", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc0876ff-9712-4160-82de-3d68a8730172", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33748587-343f-4b61-ac11-fd9c9799fdb8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d819f31-d152-4922-b524-76fb54673b4d", "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": "674ed190-454b-4a29-a827-2b2a30d3a822", "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": "58fd5755-bed6-4b85-b760-257d4e436b97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610820ac-07ca-43c6-8a74-e1cfaeecf5c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4346d78-7175-4dcb-83bd-d854c165425b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038087c1-61e6-4244-a763-3de4a979b244", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "765baa60-f6d9-4d8d-af6b-e7e7025774a0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a67a6535-783d-4dd7-a0e8-14654929e1cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "047ca9a6-fd6f-42e6-a05d-c5d86b20e03f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eddaa96f-d0dc-43bd-990e-604a7dcdfbe8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2801ebcf-592d-4327-8fec-4445cca5eeb5", "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": "76a4e259-8fe6-4691-84a7-0dffd1ca8a8c", "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": "ebe8d6d2-b6b9-4702-a4f8-9be5b95fd2ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86cb281-940a-41f5-8c2c-d76d19599459", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47a0be63-5a9b-4d23-8f1a-abd82fdbcc1c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7229085-3033-45f9-9f3e-8ccee0cbc2fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd9806f-6c2a-4e35-905c-8e6b10318315", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fda54f9-6c03-46f5-a151-43218c4561de", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19aecc1f-226e-49d5-b13f-f9192cefee19", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99987974-6b56-4a78-b9ba-d79e323f7ec3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df3396ee-0764-484a-9075-cfb57f999dd8", "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": "44547789-b5d8-4cf6-9141-002afd4edb4f", "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\": 9662,\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": "f7df2af2-40d5-4262-94bb-cdcd5fb95330", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7811bbed-3bc7-430d-9501-4ad9cdb7d814", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8d477d-7dff-4d5c-a242-1e8015217c2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8771509-07f2-488c-826f-0997f693573b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f880030e-a299-4651-bf7c-ca380e6e6c7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d4fbc7-fb70-4532-966e-d716aacba06f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf58abd6-ac6f-468b-a458-c86b9339f774", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d700ea96-67fc-4e40-89a7-1fa5a0d58079", "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\": 4327,\n \"message\": \"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": "182277bc-84ff-4e49-a979-0d312cb3d2f3", "name": "Email Address", "description": { "content": "Email Address endpoints.", "type": "text/plain" }, "item": [ { "id": "b5c84a46-8a0d-4472-befc-54eac9b95120", "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": "94fb653f-eca7-47b7-a3b4-1b82c211bcfe", "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": "09451e9c-2a9f-4ec9-b7a6-bd0aa34ebfe8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89162501-f062-47cb-be43-fa0fbdbda31c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fabe6b9-7d09-4543-aba8-0682dbfa5ce2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3059b65e-6043-40c0-887e-7f7350f0d4ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94f6815b-1abf-4ae3-bf78-53dd158a4c87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bd0b2b0-1fdf-42c9-89cb-506c8d21d744", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1541242-4085-4cac-80c8-645fb5de7143", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d82c80d-8f62-4d67-8e5d-f33e98b65ee9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08ceebee-59e7-4398-8cff-ab64e679f92b", "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": "cd10ab6a-a269-4f97-81a0-2d6e0d5ea76c", "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": "e6fff679-cbad-4c74-a3f9-f1c02a73b7c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a58463-4605-4579-b874-52e204fa1f03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9032cf79-2bc9-4640-84a5-9585ab6ca792", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045fe7a1-5e5e-4c5a-8357-0ecbff81d248", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "403d9c7a-8ba8-4173-97ba-59ec86b8c8cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d349c5-ad54-44aa-a508-2f1858587264", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17d9de57-57c5-4c26-8550-f4462db2d87f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8d19c5a-800e-40f5-a334-c043dba7a678", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b6e8676-7c61-424f-ace9-46d993d4f82c", "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": "59618749-6e48-443b-90d7-1375f5783536", "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": "f61faf31-dcea-4426-abbd-78ccc85cbf42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "732f0e84-60cf-49e0-be72-0f74e27c6622", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c3f614-7e3c-4166-9abe-6e64bbc0f09c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "760d013b-1426-49d1-bcc5-875277162f62", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23372ef7-d479-49d4-9fcb-ae658283ac77", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e397e55-b32e-4281-abd3-499ba0310f4d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cbc893-9c25-4cf3-9bb0-5923a2d30726", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08441d8a-4b29-44a5-b325-259e7ed0edc7", "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\": 4327,\n \"message\": \"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": "237da263-cedf-45c3-8885-ec79e5dde831", "name": "Files", "description": { "content": "Files endpoints.", "type": "text/plain" }, "item": [ { "id": "5337506c-147c-497c-8e14-24f8bf5df130", "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": "ef4be062-6fa8-458c-81d0-c7635aa0a01f", "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": "5eabb413-b068-4bfa-a5c1-3a53fe9be871", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33a95312-66d7-47f7-93e2-83d2e019290e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf61b4b1-5dc5-402d-b6a2-9d3c9d4577c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "277915d0-4124-4c47-a5d9-d1bcc37c18ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba5e7a94-8c33-4a08-99a9-62597cb0ed90", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d711b293-584f-4db7-ac93-c49492e0b127", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72166913-c4fa-4782-8f9d-40b741ea7f11", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25d8251a-4752-4e0b-b513-91e1661568e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "153189d4-97e5-41e2-8416-0b6ba4094594", "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": "abc5cc98-483a-4a6d-8cf0-5938e8ccf0bf", "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": "9d864b30-33a0-4b89-b98d-302c966bdf83", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddda1947-c9e1-42cc-9e7f-f674ac766c6f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8194efe-7f50-4691-b6bf-a2f669e5d987", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9845c88a-478a-4a84-8b0d-922b47de3dad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "247ef60c-197b-49ea-b0ad-91fc615cd380", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e45cd35d-b346-4fa7-be05-b766510ff147", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e17c1f-7274-412c-b910-dd0fa5188e8d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b825288a-31e6-4eed-b2d5-367d433ff0d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86d3a9f1-923f-4b6b-a72a-c78de1cb5dea", "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": "bc6658a2-3b33-45cd-8197-1eb0d1f1aa9d", "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": "8dd0e2fd-55b6-4fff-b424-5c439b90aa99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3cb68ae-ff34-4720-aa3e-8c41beaf598d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8169af9f-4058-4441-9ce1-826b0c4aae21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d129abc-d38d-4d99-9d45-0e34ff67382e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46b46e6d-27ff-4651-8d84-c6cb8c843f53", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fe703e2-7f7b-458e-807e-d583d252d920", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462d8af1-bb7c-481d-9a16-589f0a093d97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bd5973a-f135-4227-beb3-4db1a634915d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7867a25a-cee3-4dca-9e49-05c97454432b", "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": "is_public", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "file_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "file_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File to upload" }, { "key": "file_name", "value": "string", "type": "text", "description": "File name" }, { "key": "is_public", "value": "true", "type": "text", "description": "Is public" } ] } }, "response": [ { "id": "cb304bb7-d89c-45f9-b308-28c55c0aa100", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "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": "99b6051c-9f0a-48c1-999b-616c4061be20", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2abff5-4712-4378-bbde-7263fd336dea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd16c402-a1e0-4584-9c9d-3d0c3cd78f55", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b998349-d4e4-41f4-82e1-6b1a05deeab5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566e2213-f491-4548-9f4d-5b97641a98df", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49758d8a-ae99-4219-86a7-56c116d70a03", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956fcc05-d839-4da7-82c4-f708e6a7e1ef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222ef2ae-f8e3-4df4-9ab9-6de5eb36c8f9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "file_name" }, { "key": "update_mask", "value": "file" } ], "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": "true", "type": "text" } ] } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca41d6c2-cf5d-41e8-a872-10ab7c2b1bca", "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": "991942e2-1037-4f89-b921-a07dea13ccf1", "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": "a0e8a35c-d082-4f8d-aa3a-f14efd4abb14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "099a2e02-14ad-4c1a-9318-6ff89c7eaa02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c94b22e7-3d2d-4e18-af82-d33a5d5fc044", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257bd85f-25d9-48f6-b944-aed48ac26a9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7f1f060-975b-49a1-a8e9-fac7cb74f3d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240cde1d-04a1-4c88-93f2-5755a1a4f9e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53034ed9-f7cd-49cb-b844-66412f08764d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f92213a6-e923-40a4-a641-ef9f1cacba74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c80a7f8-2392-4739-8387-47684ef62fa5", "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": "e733dfec-f191-44ae-96bc-fcefd8e4f950", "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": "e3637969-760e-4b5c-9b25-c691c711cc7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6e52635-6f71-4366-b030-1a9d8c4f87dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e76bef2-1b68-417f-9551-f2d43cee9197", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61ce5f9e-27b2-47eb-ab29-5526c4a7e408", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1190f08-7b9e-45ea-b353-7684b7c13dda", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6392bb0d-2d82-4815-90a3-bc96ad5256c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa240dac-200c-442e-b669-5cc48849be69", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75fef9d4-e4fc-4e30-8b5f-069e1706cdff", "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\": 4327,\n \"message\": \"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": "b4bf7083-899b-4485-b750-5c428815342e", "name": "Free Trial Discounts", "description": { "content": "Free Trial Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "daca314b-7165-45e3-8994-4e8f087b0d96", "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": "6c0a01ba-2789-45da-8b0b-4efdc4c077c5", "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": "aabf14e8-2200-440b-b311-536e1a77d778", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64cd2a1f-cfbb-4866-9ce9-a3c935285075", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6953f8a7-27c9-46c9-b49b-84bdbe924448", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee07de07-ba78-4502-a561-048d9462c75b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2e8b75b-9160-487d-a36e-a8435456433d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a1cd8f-dd3d-4afc-a30e-c4fc619cb166", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "553f13b1-ea92-4f92-80a0-cc288e720c56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cac2343c-e554-44fd-ac08-217c0b4b70da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2250d5b0-f8fb-48e1-9a9e-e2b9469dfba1", "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": "e4ce8818-fbf4-4573-883b-16a6f6a57c3f", "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": "37283960-c00b-40bf-a8eb-8eb27943e802", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "697b51c6-3bb7-44c6-baa9-b5a46870d00d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9ea497b-7b1a-4b3e-88e2-1843b8f32a8a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5187ec80-996e-4ac1-92b4-ab98ddf748e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7857f9a6-e0a9-4c1c-945a-1ed96cc1a9da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f644734-f695-4833-afc0-4ed69b402e14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f16939b-9de0-4126-92b8-4f3bd6c38f14", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9119b060-3ab2-476d-9c46-e6ef7abf8429", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82c7f417-6ed7-4ea3-be3f-ad76518226e1", "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": "62c46cde-1595-470f-bd61-765e7282fb6c", "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": "33605012-d176-41c7-a189-ee8f97e2ff9a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34743693-6ba3-48dd-a379-48f4af2afd7c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9cd7c5-e354-4f51-ac07-cd9f09795184", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d88d8b3a-d32e-4907-8299-ebda8853cf9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be399709-f602-4844-8169-86f58edc5c8a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "541cb9f7-f702-4bc7-841e-1128edce163c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4272dc47-6549-48f2-b425-f99ac9a6ffa9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14013b78-651e-468f-a1c5-51b7094ffa39", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "330a03f0-da06-49ad-817b-10b89559bd64", "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": "69156ece-e64a-44fc-9cf3-afe962c95871", "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": "6e5be437-abc6-40e0-b463-7bf6cb2a655d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a6f42d7-7b14-4d2b-b042-17c8fcbfcd30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b7e95e-7a36-41db-978b-55a818414eb8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd76396-6bb3-43b5-ae46-1d82f3e97a88", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc108ad-f85e-4f0c-b630-98788c33a5a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50ee6fe-d36a-4811-bfd2-f7a1b08c6e61", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ecc021-c9bf-49ba-b4c5-da2260c56c69", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a35875-ae69-4d9b-a9a6-0d136bc698c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fc84630-537d-49f7-af87-12f7c198c76d", "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": "36fa27e4-67fc-412d-aac3-9b3782ce29f1", "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": "0372c12c-eab8-4cc3-980b-74409be945b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35585e60-cc73-4570-b018-b1c7b91e0f33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c29009-ae2d-4f37-a384-00732df62e36", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5240befb-abad-4be9-98d1-49c704fff62b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae2625b-aa33-4655-b7ff-e733cdf823f8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb1f6edf-85bd-45ab-bb87-dd6c599c61e0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba97c6b-6ec9-4752-80dd-7b8efc40cb35", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b763b3d-d8c0-4073-a444-c940c5d9c0ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0eefd4de-92f4-4771-b712-512d51899e81", "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": "description", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "subscription_plan_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\": \"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": "cabbab94-97ef-4481-ac31-57ba3a6ef001", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\",\n \"free_trial_days\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4939acde-4b8e-497a-9a82-9658b5ec275d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa58b6c0-472a-4ed7-a2fb-388bcd588e2c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0491d228-4d8f-4be5-af02-5eeff6b508a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "810684f0-eca2-4b8b-8c07-e2ca672b2498", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c3d39c-2858-488d-abe6-1aed6bde5a96", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25305d41-bf42-405c-a18c-d1c48d8b06e0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75110552-d388-45f2-9c0c-a656523a921e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ddc2d05-66ab-4ef9-be41-522c16c3e177", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "criteria" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46e1701a-09fb-4bc8-aa1a-b56d8509b432", "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": "3006b19e-2fbe-4a5f-9c37-3a792d727d32", "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": "cfacc41e-6ff4-41d5-aafd-be7990c79203", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fcc7ea1-d460-468a-8ed6-f7aaabe0e6a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f40ca10b-3c1b-4943-a367-5e45e566212f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25679c39-1129-4c64-bd35-e9c947427227", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19230b95-878c-4bfc-8fad-5dfec154065a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c86dc0-39a2-46ed-a05e-80492649fb94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff5afb2-ff05-482b-a521-d0ca08055acf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322a5f97-09da-48a7-b2e0-1702866ad5a2", "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\": 4327,\n \"message\": \"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": "476400ff-5fcb-4cd9-bf7b-95fd5318ac70", "name": "Integrations", "description": { "content": "Integrations endpoints.", "type": "text/plain" }, "item": [ { "id": "1e4853b5-3424-4ac3-9a0b-d1e3db19ae93", "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": "30de5883-9a7c-44e6-8f17-6fd79a830bf6", "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": "b3cfb4fc-13eb-4564-bb5d-ef268f728c44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "238515a7-3b82-433c-bfff-46fa96506a6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ceebecc-5f61-4ad1-8879-e773a5cccbb7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a73e8218-b3cb-46a7-b353-962506246cd6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e10a8bf-f5c9-4658-ad62-7f99be3538b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f8b6c0-1dc9-4916-b5c9-98e48154621e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a7f0e68-1c68-4396-8a3e-d79d78646f66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac7d268-8710-4482-bac1-23a90604b8b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ec09d7a-f94f-4e45-a6f9-ee97f1f36bd9", "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": "8a730b42-38a0-4756-85b5-e0de21afeda3", "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": "aa901422-dbd6-4a88-8b3e-8f93177320b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87604f7d-7ce1-40c1-a212-1cf39b762094", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e65961-f839-4f69-a7f4-e3dfad5103e5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85f283f4-caa0-4bba-ac01-74817ef214d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5944d92-5738-43e0-9c8d-9608e6f64f75", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c6955c3-570a-4c1d-8c7b-6afb57a5d4f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec5375be-ded4-41ba-a579-8c39a1191a7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37e5c0bc-0c3a-4499-a416-b6bb41dcdd1b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47940ef2-4da5-4bb3-a273-80f3087a3604", "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": "e91bcce0-cce1-4ee3-bc18-3a0965d51c9d", "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": "e2bfa22e-ceaf-4c18-ac28-67af53ba64d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b9cf29e-2b6f-4cd9-8695-a67be0626288", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d2992a1-0bd4-40c4-9bc7-3103830dcfe2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e83c027-9106-4d95-8d8b-59c64da21711", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7044bbd4-74c9-4f0e-857f-63856d1b1d2b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8c4021d-7247-4192-b61a-88cce6cadfd1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b8ed02e-1c30-46fe-b77b-74565e5ec869", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386fb621-a310-49fd-96a9-45d2a39bb793", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "994b517e-5c6c-4b1a-aed3-e233768b5051", "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": "6d93d4c6-7e99-4edc-9fac-9ac81a99e4bc", "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": "0156707e-085c-4770-b506-1dc5d7f13d15", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb82873-761e-4bfd-bab7-1b1592cb00c6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "094ed574-6d97-4e39-956b-bfaeb9f8d1fa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c68d18-90e4-4c63-9e3d-4654bf0f2b07", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d60de3-9d56-4bbd-b862-16f96acc60c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de903f7d-82fb-4a20-a9c8-ecaae74256eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "effe2b7b-7435-4095-bb95-a8a9727345ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a8bd8c-5156-4caf-80c1-c24bb50f3c7c", "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\": 4327,\n \"message\": \"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": "75682f46-a6fe-4ea7-a7c5-fd6ed801616d", "name": "Lead Source Categories", "description": { "content": "Lead Source Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "503251c3-1676-4012-bd7b-6288d827f43c", "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": "30687163-bc22-4688-95a7-0878c1cd38ca", "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": "0d6db7f5-6595-49c8-8780-ae3973d5ea94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197ec7a6-4585-4e71-bac1-c96965f4253b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfe1844b-f92e-407b-b9d7-0f7487eb3bf5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274b4168-a58c-4493-bf18-d00f470bab78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e30ed4-8c9a-4ba3-81f0-708a1cbe46a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ebce0bd-8cb3-49bb-982a-924068994c94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eaab9e5-ea87-48f7-8629-1fad51089e6b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c82ccf-c3c5-4a7f-ba68-e4ba90526c85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1beb78d-005e-40a1-b8b2-63e507dc465f", "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": "fc0dbbf1-49e0-4c57-bd1e-23f91aba05d3", "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": "b916288d-0868-4119-927c-42e645d0d137", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4265b9a5-a34d-4ce1-b5f3-9a43bf21f526", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e13da6c-76b5-4a18-b4a8-b8531718f134", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d72c0cde-602b-4ee4-804f-91ec2e17a23b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46722386-41ed-4294-8f80-3b2592476f35", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aae4a1f-8c37-469e-9b1b-5684c563a629", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "330cf823-97e0-4f1f-a58f-692635c37d0c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea4ecb1-feae-48c8-a6b8-a21f2b8f7655", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adbb5968-f7a8-4784-bf70-b76828583ed4", "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": "3e76f4bd-b1ae-4c21-aabc-2143ed18f154", "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": "c7624a1a-d488-4c69-af65-b4eed8883871", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc1abd38-0b7c-4dd0-96da-0d5de9db4e6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "268c3f5d-b18c-4247-b3d5-f1348152649b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bb81e22-29be-4f49-b3fb-e3a6f62acb02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6721f1d-9dae-4407-8b50-d3f04b4d4554", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5fe9b8-8153-4c2f-a5a8-d6a773c18641", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ed0fe1-eb53-4df7-9168-b35f38dd61e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac68346-48e9-4011-b2f3-e28a40cd0b70", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f58082c5-deb7-42da-9f82-d73f31e2249b", "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": "07314524-f85e-4e54-923f-91380d8d7a25", "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": "3d76eff8-5f36-4357-b68d-887086837369", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9607e130-ebd3-4936-b0e7-2b7a8168d5f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c1a0a2-1a59-47b0-a814-0f46e476e41b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc7a67a-e031-4d8e-89a1-d129e8b4b5c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce5c99f2-f1fd-4c88-854e-ecce9eb9c3a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26f11f0b-96d8-40f6-b9c0-0af7ae2671ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8607309-8c76-4fda-b748-28a9aa37b85d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "607742d2-4570-4150-9aef-d57fbddefe5d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bfdb968-89a5-495b-93cf-1b7e91682492", "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": "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": "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": "61a5b3b2-faa3-4f95-955d-c5d1f07793a5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c32be7cd-970f-4f5f-b096-99696e4d835b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d68755da-f78e-434d-a199-1f63cbd22810", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8763cbd3-157d-4f85-bc8c-248fd9521e1f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ff9636-dc98-4b42-a22a-a5c9e3fcd2fc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63c1b5f0-20dd-4006-b1b9-1228f97b9e78", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1734d79a-8d4b-472c-8262-e6df20a558a6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "619734d1-35ba-4a59-af8d-e2aec06e06f3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f97f2a-cc4e-410a-9a57-25a17d142016", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"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": "aa63df20-d565-4845-b692-9730daf926db", "name": "Lead Source Expenses", "description": { "content": "Lead Source Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "9fa70740-4172-4138-b7b7-782949aead34", "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": "8cbf3b8d-c869-49b1-8cdd-76645b91817e", "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": "815efc5e-2ab8-463b-ad01-7cf3aa771262", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a3b6e3-8fa3-423f-9d12-035ad263865a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0caf25d-d433-47b9-8c85-83ef7febc505", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a394dad6-1aa7-496b-a41f-a47fde949a8e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa949211-4425-42f1-8b52-db965a415856", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2bf8600-4c87-4d18-86a9-243f8069c3ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d2ebe64-f021-4677-bdd3-b777a298499c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0619ecf7-dc61-4e52-b154-b0eb5835bd41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89d262d4-55fe-480e-9500-e1c03ec52e98", "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": "412422fd-b14b-487a-a94a-4c50d570f0a5", "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": "8ae070de-d61f-47aa-bb3d-d559e3b73606", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "055743e6-ac74-4627-9d92-aedceb42de6a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09b00f0e-049f-4363-af83-f2133ff800d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2979d4f-fdb5-4ef4-90b1-9f80473c41bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6211a07-fd01-4555-b898-b6ede5b0929b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6b650d-5229-48a2-9e28-e769ce74c6c9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06963d94-e19e-4b1e-a241-ac5cd67f00dd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd3ee1a-da3f-40a1-9c1a-3b923d480475", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dbaa672c-e798-4f61-b285-2bd33c35d7ad", "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": "f036a9eb-72fd-4e41-a490-b77c5d418673", "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": "8094d1e4-1b76-42ab-a72f-0248789efc4e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdb2b86f-bf0a-4aef-85df-cd49ea9aab4e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0372ca4-5541-4670-946c-e597beccf780", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca638a63-af2b-4f92-90e9-09be45d6b838", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9d608ad-6b8f-49a4-813e-21dacaa9e7cc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5412718-bf1d-42b0-a68d-da84ba195e97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7cc2529-0ffb-40e6-8350-53a768c0813e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9413624-e104-408b-a796-c4b735bc925c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d679f0bf-a7b8-4a62-8ed6-d4416a01fd6c", "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": "6939f2ee-1a12-4597-abec-8a141d8ea99f", "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": "298094e3-a9ed-4781-a61c-ec52df1c68d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2db4c1ac-dafd-48df-82b8-120cb3252ed9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "509e6e3c-7a3d-4ded-a7d5-7caa4fd1ea98", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ae60dca-b6f3-42a6-92a4-0e4dae5a1df6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0f5e21e-3bbd-4e3d-96bd-f092489faa37", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "829caebb-8125-4587-9552-882f468f30d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "765e0230-a089-486f-91e6-a3d3ac3fb2a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f2cfce-a909-44f3-bd0f-812cbec1d7e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40b644da-2be0-488c-a5f8-8085a49b14c4", "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": "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 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": "5efeebfb-7a1e-45db-8d9d-781f28de915e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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": "e2915f97-6dec-42bc-b9a5-1cf8c68bcc5e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b7f33c-e845-44e7-a14a-c12941756a94", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd31310-783b-4c7b-b33c-488a9bd2ec2e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1407e4b0-0e0e-4f8f-b485-54e1d7f796c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a6c2c66-31ae-445a-8cb6-565cad2acd11", "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": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33ff1d90-ff3d-4c46-8f94-2525fe05502f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "expenses", ":lead_source_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c82f4f7-ee85-407e-8c62-1b99e04b249c", "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": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4575da60-92de-4e58-a956-dfaf58a2194b", "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": "title" }, { "key": "update_mask", "value": "notes" } ], "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\": 4327,\n \"message\": \"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": "31f179a3-5c77-440d-a067-cf65db8d3f18", "name": "Lead Source Recurring Expenses", "description": { "content": "Lead Source Recurring Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "8624dd5b-ec7c-4135-9af4-028acb81922f", "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": "8da227c8-5c3e-454f-8d19-d0514ca9d743", "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": "fffc2698-37cd-48bc-ab97-21fddc28e8a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22dcc42f-0852-44e8-afab-1e88af768306", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9db21274-fc27-4673-a0c8-e0ce6470951e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "118b0878-f8df-4efe-bb10-179d0c80080f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e822c17d-f5c9-4b7c-a425-ec8e47359462", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb552415-b3f7-4fe5-bf11-79600add49f3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6e83257-95db-410f-b6cc-7e21860daa33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7251c96-f096-4d16-a06a-833fff061713", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da1a943c-01b9-430a-b2cc-c27c26f98bba", "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": "901e0343-7f30-469e-9806-1fd50fd4cfd9", "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": "3ae98710-b64a-4b42-86d9-a7ed57aadeeb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0173a10f-0ff1-4dd3-ac0b-c2492c3d9053", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e0b067b-95e5-4a23-940f-89f4e6e993a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d47101a-19b5-4d95-becc-5e5aa434d43b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a049d0dd-3504-46c0-ae6a-7ad83115b48f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68623c8b-443a-4ff0-9418-d3ba73cf39f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c326709e-7fbe-4a2e-9a59-770d5dbeca30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b43a7fc9-a48c-47a6-a849-c78d7d879149", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83eeaa04-c37b-45d1-8dc5-4166e7fd9f93", "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": "6394fd3a-47d3-4462-a236-7447fee2a3d2", "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": "6b34b5d2-404a-424b-85c1-ca7d8bd3053f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab89080-3df3-46f1-8046-38478682b054", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c95540c0-5527-4c4d-a40d-7dfbc81bf754", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b83f07e-07a3-4062-a46a-5c61fd1dc1c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "957e92af-d840-4459-875a-ac6140c1f042", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0cf015-22f0-456e-bbbf-3969ea13ff3c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6375163-8d9b-44e9-9bb6-d0011341ccab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a88d0d84-1d21-47d0-b103-fcdeb8b6686a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28721489-8e3d-4262-a626-e6b6fe8353ae", "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": "268facfd-6136-4d80-a0a0-0755679c0ae5", "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": "d2449286-1808-4a8a-8b64-267cf074f523", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8963930d-00bb-48d0-9e44-4041395ba63d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc1c0c5f-5670-47e0-993a-9ffa9d1cee15", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "368831dd-27c8-4f27-80a1-b649a7ec1e33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a976f0a-42b6-46f9-9365-d22eeac95b7d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbaa6e19-35fe-4f7e-9bce-65fd4eead610", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "174bf7c0-b585-4bf3-84c2-ea09156f60f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7080c760-0fce-47bd-85f0-6b2ae02b4d17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f31beadd-b0b2-45f2-b2cc-3cdd73432e02", "name": "Update a Lead Source Recurring Expense", "request": { "name": "Update a Lead Source Recurring Expense", "description": { "content": "Updates a Lead Source Recurring Expense", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "amount", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "end_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this recurring expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_recurring_expense_id", "description": "(Required) The ID of a lead source recurring expense" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Monthly Google Ads subscription\",\n \"notes\": \"Automated monthly billing\",\n \"amount\": 22550,\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-12-31T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90aae1ce-e8ef-4cc8-9f2c-741223bcd7fb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "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 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": "0ce9142b-7325-4c88-aff5-2a38241313ce", "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": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1fcdf4-1ce5-4093-a796-b45ebb6958bf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed9ce360-74b5-4f27-ae51-3ee72de832f6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea8f316-84da-4dee-9faa-c0db719756ec", "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": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fc13902-0d77-4dbb-825f-a47ae6ebaf84", "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": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f9f1a93-3017-4221-9de6-d63149c1f2e0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "018e3631-816c-41a6-8ff7-e2e4a4e3d1d7", "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": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1c01d0-c38b-488f-91e6-9241572b1724", "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": "title" }, { "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 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f385c9f6-87f4-4117-a501-a51957f5966b", "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": "3ee563c1-6fdb-43f5-9904-063197e6e691", "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": "f4427c1e-f0c9-42e8-ad26-d45ea8339c33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cdf96df-1649-4167-aafc-7509913db027", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70bd84c-3ddf-415d-b91c-dbe21cda78eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "068adf60-47ff-4aaa-b058-060bf4e7f641", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b361057-50ff-4927-8e70-a36b5fa7d9d9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "748bc1e2-9b40-48cb-8a95-f94692ca2571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc78f37d-110f-4214-a57b-780004e2e1ab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "555ed5d1-25a8-4ac4-ae83-6b1af9f293d9", "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\": 4327,\n \"message\": \"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": "b155e9c0-5853-4b9a-8627-aa47e183b4d0", "name": "Lead Sources", "description": { "content": "Lead Sources endpoints.", "type": "text/plain" }, "item": [ { "id": "1cc0b2b7-4dc5-491b-87bc-099573f45e0d", "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": "acd99603-a049-4cfb-9e5d-47316a6ff707", "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": "3fcf770e-8ff7-4d95-bff3-ba698857ea3d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24081bd8-a6de-4c8a-ad10-258dd9d96eaf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22c6716f-c3b6-4693-b6c9-3590c0eaba76", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c93f8044-c427-4274-a630-082209c5506d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54eb90bf-a7be-4e71-b513-546ab2c137cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3896f81-c362-4208-87d3-fcb9ba31fa8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86ee00f7-d261-47c8-994d-a6bc87fa0175", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f6d9919-80b2-433b-967d-b05bc95e2a7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c688b43-509e-44dc-8e36-883057ecbcd4", "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": "85726685-bc19-46d1-bd67-3e57758e3669", "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": "817b25d0-6ded-4d8e-a455-43b8dd24c6a8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b794e1a2-867a-4a77-8aeb-a5715c61d16d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d096ee6f-1856-4c09-aaea-728c500a6cb1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc3833f5-a152-48ea-972c-6d4a959dd37c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1782db6-2b82-4edf-9730-18263f28decc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "066db227-b7a9-4410-869d-5266c6a3f950", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3f6ee43-891f-44ce-9b78-995652f25935", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bba03e4-69e9-4988-82b5-53d5260d3bdb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1dbedeb7-5090-442b-8472-91a382328ded", "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": "977aa3ba-ca46-4bd4-87f7-706c142298d1", "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": "2ae3387b-c30a-4ef3-aa44-93e053865706", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39b7de1-fc93-4ab1-8b72-78c7d1514620", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ae7a97-cbe0-4473-b8e0-76fbd8188252", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70b00546-4644-40cb-94b8-b5637967e41c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f01d4354-6e12-4621-91ee-308d7b0e2435", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60a6ca05-a418-4936-b3de-45c02ad9f833", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954729af-e48a-4af6-9b94-4b0ce2d287e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e7fc516-1d3a-4d7a-8aa9-541bc59215fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "559302e2-6542-4c4d-b95f-45a05440c2ec", "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": "5dc875ec-ae39-4f79-95fa-b0c7cc8e6143", "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": "3d00ca0d-8115-42b2-ae0c-bcdde8c4195b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f37df26-e045-47d6-9f0e-77b304b69d75", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df0d9cea-8923-4bcb-9e5e-f5c9d757e4d0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21fbcc30-b6af-4e18-ab73-1aed4be08ed8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaff83f2-df2b-4d42-a827-d753c0f04d7e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f798b1d9-8b43-4406-885d-17121f4ffd17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3647d05-6aad-4c21-97a1-1f18c27de4c9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f785e1e-0db3-4b1c-9675-4ec305e6506d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cee391e-1102-40e6-b683-c4ccf33f9b5e", "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": "vendor", "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": "medium", "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": "beaa8e2d-6d42-4fcc-bf5b-593f0b584843", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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": "90fbb38e-ebfc-47ab-976a-0a832c07814a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81412351-34a6-4898-8733-fc926b67435a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "275ac8a8-a8af-4b30-a833-d26a71eff5d4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d3ef64-6572-4d32-a0ef-9da15fe15ca6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "897be71c-63c6-43ed-ba3a-1ce7c8fc650c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df44f563-ebf2-4672-8bd8-4932de253163", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f198579-8ca1-4a09-a112-a88b411b4fbf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb10439-9b7d-4112-9dbb-b7075fdfd710", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "start_time" }, { "key": "update_mask", "value": "name" } ], "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\": 4327,\n \"message\": \"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": "ef66fe1b-b527-475a-a34d-563612b54197", "name": "LeadScore", "description": { "content": "LeadScore endpoints.", "type": "text/plain" }, "item": [ { "id": "55e62757-7e0c-434e-b5d8-47e5817f3c1d", "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": "a86f3b45-3805-4e01-a33f-322052e58d8c", "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": "0588c6f9-3a16-4361-a0c6-265e5e77b633", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448d9f6f-c6bd-40a0-a140-edc082d63aba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab0c73e-9260-4c76-ac00-1146653acbb4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc01e43b-1e48-4f70-9ceb-44c3cd99fa95", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6468dcb6-5e4a-4687-bf2f-e113c3abffb7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "041d13f5-028c-46bd-91c4-460e5d52ad0c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ebe7625-c72a-4061-be12-5fd7f3123579", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58b40204-cafa-42e1-af63-57d113461865", "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\": 4327,\n \"message\": \"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": "03d7e0d4-6fb5-480d-bf06-b3cc5a02bf85", "name": "Locale", "description": { "content": "Locale endpoints.", "type": "text/plain" }, "item": [ { "id": "b24587f1-aecf-46b5-bfc4-426dc22b4b3e", "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": "13b70eff-c65c-4f3d-8aa7-a8e02c4b9051", "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": "df0fb490-0efb-4674-8d9b-3cb338f8d3dd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54aee70a-ad5a-428a-9c8d-01063485521a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab7a6aaf-842c-438a-891d-fbe899f317f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa83a918-da78-4aba-b608-c37651f66f73", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "953b1809-0231-4e45-ab67-963c39b167cc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e718d9-5326-495b-bc49-f2a385c682aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c4a770-c123-4d6f-ade4-6eced6ac0d1d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "454b8744-ff38-498d-8c76-cb7bf6ee3a2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1328a0a-6540-43ed-bff8-b339738758f3", "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": "7e8d510f-0924-4c98-acab-d883ca6517ee", "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": "0a2720a3-44e8-4c1a-a53c-51bddf75da87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eb8e6a6-bd42-4b91-b3a9-88912b22c868", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24b7f0eb-78cd-4f18-b478-af0898ce72b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6411c402-d6b8-49f0-9290-bad1e4e6fd10", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "017d423d-6903-4469-a93d-10034e89ac3b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b1ea76c-410d-4291-a65b-48bd8e10173b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4d422e-fc21-4fff-a8c0-f38c5aa4830c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f9474b-ff9c-4712-97fe-2b5dcf1680b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ff2ae9b-bf8a-4940-963e-3111646fd66e", "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": "91abbfea-ddf9-43dc-8bdf-35d92580e90c", "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": "720143d0-5b08-4578-b8b4-4dd01f88f3e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2c27aa-f643-418d-ada2-f8923d386608", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d33f2a2-0714-498e-97f2-4a0eed11678d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d971c87-583c-41a8-b7d2-68eedfb10f5a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2331abaa-3522-4116-ae6d-6bd11e68e49c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c8b6422-cd20-45a9-bd65-aaac11053eea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fc4a5b3-b346-448e-9a2e-2b33733811f3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027ce107-dc58-476e-bcdb-b692476eeba5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9f55d13-5c23-4bbd-968c-956f763bd6ce", "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": "af78f504-3235-488e-923b-8fc1660b8b60", "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": "22c2e148-067d-4606-8e93-e7d8a17df83a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f95824-4549-477b-911a-f6ee2efe0a56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55858024-02a8-4fd5-a489-ec41cc0a9f45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc60596-07f9-40af-bf32-cbae3657ab13", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb8cad95-e661-4389-8fd9-af94888927f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d67fc30-51c6-4979-86d6-fd5b5514bc0e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eced7fa-7326-4074-bfaf-fb3d3fe6dd74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ecf4d5e-ba49-4fb0-9418-b7cf3c151ef9", "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\": 4327,\n \"message\": \"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": "2f6ef4eb-bea8-4911-a0c2-872aea9b5ba4", "name": "Merchants", "description": { "content": "Merchants endpoints.", "type": "text/plain" }, "item": [ { "id": "b8183ce0-4d17-4b17-bcd5-c26f648e56f8", "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": "07cb10c9-f7ea-4397-bc4b-e338c6e19ed4", "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": "5c4e92b9-0fdc-43e3-ba87-9f7f2eb91170", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b68673ef-08f6-44ef-9624-bd9159afaf1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "466ed7ae-a278-4836-9f59-aff18030f7f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3e8d870-fd06-4dc2-a2ca-962bed4cddd7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83df7f3d-a5f4-443a-a3fa-75273c27833f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72bcf04d-3b27-4dac-8736-792feedbc6c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc8de021-e6bf-438a-84c6-6bf472159ea1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e9e63a-e0e8-43a3-902e-decb99fc20d9", "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\": 4327,\n \"message\": \"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": "d9c628d7-c7e9-409b-b744-ee9353ccfb5e", "name": "Note", "description": { "content": "Note endpoints.", "type": "text/plain" }, "item": [ { "id": "c6e27474-d6e5-4a79-a01d-018cced5f965", "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\": \"DROPDOWN\",\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": "150685c4-6941-4437-a87f-92eb639a1132", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccf1352c-483b-408c-a910-72f0f4d45729", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57534b88-dcdc-4ad1-a364-ad4333279b83", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af6e163b-9537-458c-9f26-49d1b76e731c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e573dbf0-87c4-44b6-8831-4456f4ad7a0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a129c810-c39b-4b04-a4fc-313df07ec3ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e730603c-05d5-4ed8-9bfb-3060936e7973", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cfe757f-610e-4e91-a661-20c4dd747e0f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8525b30f-8d0e-434f-b01c-407be40e698e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "340c7a60-1281-42db-ad99-26adc1aa3371", "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": "0b30162f-4c66-4684-9136-03fcdffb6dc8", "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": "4a9c493d-5133-4f6c-9254-1091eb9757e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c39747-f94a-4467-9e67-b48a7b911b03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d8fcd2-991c-44f1-b506-bac5767b9a84", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74c12e1-1f9b-4a5f-850a-15c6ee07f832", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a3561fa-28ea-4e75-99f2-69644a3881ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd0a9b9-0a4e-4213-b85d-6ccce12b707e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7c01adf-2564-4212-af56-5cbc58c58316", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e098a7e-af1a-4b5c-ad31-8eeb2d0a64d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9da9e7c-da4e-425f-be46-b2a9efd7b24d", "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": "7f81bbb3-678a-41b3-bcbb-ade779f86c54", "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": "7b17d390-d088-47d9-99c7-e8afd14b9ca1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b81c66-bedb-4912-a0e4-507c1f4dc5db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a32dc55c-28a1-43d8-95f4-6e78c38c9e57", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ef794fa-813c-420c-b672-9ec5ee16ceab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba154793-53a3-4aa0-8a2a-dd6b76893008", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1762c67-c5f8-4e4d-ac98-0c85846598b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3334d124-9630-4614-9b03-3983a0ab6e50", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "457f7f2b-86f3-49fe-988e-da955c0cdd89", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58fb9e54-0ec9-493d-bfa1-40c4065bd1c3", "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": "584fda40-13d5-4ba8-be4b-500a39128e1e", "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": "a020278b-6fc0-4720-9587-b88f4859730e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1e3bbd3-c89a-4f20-a411-53380aa47910", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3fefd3f-581d-462e-a89c-687eecdddfcc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5d0832c-3cec-48de-837c-69edcddfbf7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a8e5ce-4546-4e9a-9b70-4b6aefe0c805", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08a3a933-16ea-44de-9aee-64db107a8532", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83ce2843-b7ec-494a-be02-1b109be25a97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780d1db4-591a-4af0-892e-58d5dea2df9d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40a00704-1b3e-41dd-a25e-03ad74e7069c", "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": "76be28fb-f7cf-4d5b-9112-53af9a7f3d1d", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707b5382-af11-4b7d-b7ac-bc8ee858f047", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c65b008-e973-46b4-be1d-216b60d221cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a0ab999-2830-46e5-bbf2-16797c6c0dd8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f236f263-d71f-49c7-b8ac-906c229f5878", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b4c6c9b-1c48-48d4-a6cb-62b9c5459aae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "569f3e5c-19f9-4d65-a4f0-d089d401b03c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b54c2d5e-c38d-4219-9f60-f76b340c324f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c4cb24-8b4f-4c13-8bc6-4dc921a115fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9046ef0-64a4-482c-87c8-bf38851e7829", "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": "3b059859-b4aa-4438-9b1b-42c3d9f6fdde", "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": "78e661e9-676d-45cd-a115-5d20ebd03c8e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b826f50-5f83-4db4-83a9-3286fe95fd21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "592c502f-2f2d-4674-97e3-f45c95236642", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b027519-02b1-460b-8658-4d436a363d99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d44008d-0fbe-4fd4-a5e7-11b3e68a9f4f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5c06f7-c9cb-43d0-beba-d19125b36e11", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ec68860-cf67-43f4-8cff-5662ef751493", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "511e26ae-5692-4de4-9f44-d53e8904232e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "663baf45-dc10-4027-84df-7ee5800b8c9b", "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": "20b1613f-05d8-4e6d-a9bf-671fae9cb57b", "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": "cb775037-d376-4716-847c-b1e1624af13c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da3a576-c607-4763-ac18-fcc359457f7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4b5dec-2fe2-4eec-aada-be29079c25a7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12490575-1477-4da0-b1e5-3a5b255da500", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ad43e43-72a4-4011-9305-415b414d72a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12116105-13af-49a6-991a-0e71ef41d36f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f41c5c-01d0-4edc-a823-d4c60ca9922e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa0b8291-812b-4160-b2a7-15cfe00cdd1f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90553105-7b2b-40a3-9454-6ea6792fcaf5", "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": "492d5d31-74da-416b-a63f-f4314b588b75", "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": "b8dab50a-5472-4743-8d27-b28f00f793c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62057d48-477c-4e98-b068-4ff1f778581a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3534ec-a44a-49e7-9b84-715cf770f7a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76510bea-8e1e-4f66-a1c9-5a53bb02305f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c4eb79-daf0-4a92-a3f8-001e7c2f647e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93e7d4f8-83cf-476e-b86d-cf7db7b6bd6f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0883852a-3cf3-43f4-994e-c0e5ae44c433", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b83065f-4279-4f92-abfe-a4d089a26a9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "619c014b-080e-4c22-a300-22c362efc96e", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "f0805092-5cfa-4f22-8e43-c06a5f9d63c0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f487455e-c52d-46e1-8b7b-7318c2c8c31c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9107315c-6d2d-40d5-b977-ccd32d62a929", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7d3047-d45a-4b21-9eb1-f69e6430b3e5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aec8715-8a46-498f-a6be-5d752ba8b926", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4b90009-edf0-4d82-81c6-bcfd1f7dd49e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a166d77b-1383-487d-a0c6-7cedbbe63a4b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e11f5c-4bb6-4319-a1a7-e2ecd0e83e4d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc92179-4e05-4822-8945-dd529d065206", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "902517b6-3eaf-4091-a705-e0666297de84", "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": "20618f2c-8a1c-415d-932b-a086b277a26d", "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": "97c27eaf-f22c-4c3b-9296-5e8c24d7d1cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4764a78-edd1-4890-93d3-8c053b1a2fdd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f424c2-1e31-48db-b439-8edb73e15b9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84ce228-7bd0-40ee-90d5-c7a53ad35e51", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "958117c2-f270-4c45-94d2-4b5a2d5218f0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222d9e9f-73e3-4244-b904-8f8d6e4eae45", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "152e00d5-f239-4aab-8217-bc46d89d704d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1489a75d-47bb-4bb8-a202-f83050fddeec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c080192-6e3f-4e69-8d6c-15cbdf520b82", "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": "c473b0e2-bd09-4bb4-825b-7a81f811f973", "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": "e3a3edd8-8008-43e8-b3a9-86cbb63b4cb0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f42fdfa-cc09-47a0-8918-462e77b83563", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0452ef3d-f12d-4702-941e-b197130ce76f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba9aac02-6d2c-4fa7-be66-94e4cedd4bfc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7237b24b-3d1a-4731-b6b3-d673d399a4a9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641ac634-cf74-45d8-ab30-31f06af80f9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978bec42-8035-421a-b2c1-685c4c11cfc8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af2ad1c-100d-4d2c-b032-9efb6c03ba64", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b205487-fb9d-4e44-86e2-90e59023e2f3", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56f879ce-3821-483d-afaf-bd3d926f8739", "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\": 2514\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": "3235717d-b8fc-46c0-b6e2-f2698f53e446", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "967f6bd8-b686-4d60-a4d8-9eee5be57f95", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6708c8a-37bf-4929-b5b2-f6e641666d3f", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3feaba0b-6b33-491b-9a7f-862f7974c5dc", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4f07ff-194d-454c-b24a-1ed260272757", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16ee45ca-d913-4529-b2c0-c4ed141bce82", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f842fed-baf8-4165-8180-4d35358812ef", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e71262d5-c5ae-4e4d-93be-bd26e4975897", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20539d14-964e-4276-913b-91a66b241611", "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": "1a907f4e-bf9d-4e9e-ac6e-1d3ac178e752", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71580a6c-f8f0-4e30-b960-bd3eff4287b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17ba162f-3d1d-4047-84f5-ceb203882493", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167c1830-3183-40c5-9cdc-b969df206f4a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea954a8-a3e9-4360-b36f-c405ad0ffe44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14d8b43-da4d-41c7-870f-91e1e75a78c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b92a0b-5e1e-41f0-aaf4-14a5f0feaa8e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eefdc390-cf39-49ea-86c2-9b2be2e764e5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c623c6-0b71-4661-ba70-82a0a912f429", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f5164ca-2876-49af-bb51-1cb4a2af2f7c", "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": "c00fa452-a354-4000-91dc-b6ee1370df95", "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": "b8dcadb0-bce8-4acf-8e31-424ec04c2ef7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001e2805-139b-4fc7-8402-a70961c1a78c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b652f365-7dee-48a3-a8cf-d6ecb056be21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8d7a1f6-b327-4e7e-985e-2547b81c4f64", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eacc56ac-9ac3-4c80-9cf2-146a344e22cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cc78c5f-b23a-4dd5-a96f-a4e64306bb6e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a078a951-8707-4207-a0f3-c4d813623505", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "872859cd-13a7-406d-afee-654a56482a30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74e59c31-e8f3-499c-8d4a-99edb209f259", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "02e68841-0865-4ed4-9ff0-d3dda9bc69bd", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4f7c5b-7071-4180-9b2a-2e2d63e6c0cc", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e96c342e-9a67-4582-91b0-6ed0b371e1e4", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85847a2f-8f97-46a9-958e-69863501ee0a", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e62c3ca-aa56-4dac-92f3-4cbddb8e3d62", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f08af8a5-20dc-4d3e-ae84-8e6330524b44", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce3f4ec-a840-4342-a16a-96a870246296", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b2e1fb-65a5-4698-8a4b-148f71362424", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdaa4dc4-6534-4923-b383-8014be54d6cd", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35ba3137-f012-4b04-bf81-e6e3b95a77f1", "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": "e8f1772b-fb48-429f-93d3-78f688ea6705", "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": "f2e5c018-b94d-4515-bbd8-553a0dea48ad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f64d7b-d769-4804-89aa-a2f5809ce0eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5175076-0707-49a1-bce2-9ad2525cd792", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f039a37-66df-4b78-bc6e-0c8886891daf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd507a5-5317-4121-91e6-b6fb0b401966", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80099e84-4127-4189-acf1-6f0bad6c8700", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d543a712-4099-44d3-8d84-2dbb8425002a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f55182d-7db6-41bc-9688-94f55670526b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96e8ff90-868e-4993-9097-f72d37b8a14c", "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": "4b1df5d2-0a50-40f0-bd04-ec6a34b68ba4", "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": "d9f2ae5d-e4e2-4c2a-b2ac-5716ee635475", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf63380-035a-456d-8bb2-8c43aaea92e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4977af-e329-455c-a8cb-8423f2048436", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e2d4eee-12ec-4733-a233-0b90ac382d8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776df39b-5d2d-41ed-8223-9d6ec8fb8b8f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f90f26-fb3a-4df4-88ce-762b4261c954", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03964cdd-8682-4566-a9fa-39be609f7e7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c667a951-f930-4d75-a246-4a77f2f411d5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2017ef9-a62e-466e-9041-b9ef8663e9a2", "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": "user_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "type", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "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": "c6e9c376-5432-4d5c-a38a-6e8e0e707b1e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"text\": \"Called about the Q3 proposal\",\n \"title\": \"Sales Call\",\n \"type\": \"Call\",\n \"contact_id\": \"string\",\n \"assigned_to_user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"given_name\": {\n \"value\": \"\"\n },\n \"family_name\": {\n \"value\": \"\"\n },\n \"email_address\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"last_updated_by_user_id\": \"string\",\n \"pinned_at\": \"2024-02-18T16:45:00Z\",\n \"created_by_user_id\": \"string\",\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n },\n {\n \"content\": \"Preferred\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "338d38f3-c65e-4582-85e8-da1952cb5494", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4d97300-f618-4b63-b235-c9fa674b3a2c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257bf294-6832-4c0c-a997-1ba5e501f57f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "921bab3e-9eea-476f-ad06-9e16c1b2cf9d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b97a982b-f91d-40e7-bbb9-937eeb8a02a2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a3121c8-6c92-42d6-a7e4-6d1a5aafdb53", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ea1ad28-e9cd-4228-9174-ef94d6c4ca0d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e56e74-1811-401b-86ae-e77a80c2c4af", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "user_id" }, { "key": "fields", "value": "custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "466e87c3-55db-4cfe-8c31-73677a7128f0", "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": "f2126197-5174-40a1-a5c4-187cecec1fe8", "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": "0ad0c0ba-516d-40fc-bb23-f8bbb14bf581", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8246e0bf-92c5-4a59-87de-550a2eb5ef6a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b74989-5c39-41f4-8a20-55fd328c7547", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0846981d-22f3-4da7-bc97-00eeeb686a40", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a82de640-dbac-493c-bfb0-6c4fb87fb6a3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac4a262-ff64-4fa6-b164-a8ddd104b115", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf5fe743-3c61-4839-b006-7a2886cee4bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f1b018-1942-417c-bb49-019dbd7d440f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cd05856-5404-4441-93e7-0ab9d8c5861b", "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": "32e160f8-ff51-4c15-a0b6-9bdc8574410d", "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": "cbc2c72e-aa13-4797-aeb1-d48a94ddf3b4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2547044a-ff17-4582-8a16-2b110fc48096", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec05089-0e8e-4387-b178-6747526b6870", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd76717b-0997-4390-a673-e47282365851", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046c9efc-e2f3-4fef-82a0-b6cda7ee67e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d63911e-af06-4098-b2fc-c98390fb94b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "590071dc-08c1-42b3-92a1-70e2cc95287d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a4d441b-18ce-4e17-b4f6-97f0b64fd425", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a36d330-b100-4e02-8dfa-634704714a31", "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": "03c56b43-d8b6-4940-a008-2dd40f0a7b55", "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": "e0154e44-e188-443e-b729-eb91dacf2bbc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e202090-5036-43cf-89ad-083c51156920", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89d65a01-37b6-4b33-bc51-09c3924b07ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b909835-d6f7-426a-bcb3-643a180fd097", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b98e528-7ea9-4292-a936-75940cc44778", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d48c1790-3e92-4157-a574-5481e9e350db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda72252-4da3-41a8-81f1-ec5a08c685ef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "639d460c-4cf1-48a1-a7d9-e885e18beeb9", "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\": 4327,\n \"message\": \"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": "4f3eaff1-7a35-46fa-93f0-61575f5a0e78", "name": "Opportunity", "description": { "content": "Opportunity endpoints.", "type": "text/plain" }, "item": [ { "id": "1fbaf239-9169-4b4d-8984-7e4f3eb33ec1", "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": "monthly_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cbc1a48b-6fec-49f8-8bed-98c654dd7d1a", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "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": "53d62625-a8f6-4816-93db-bf80c5c40437", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69e3975f-ec75-49b1-b31a-53c74b234104", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d051c530-4045-4195-9a33-17c7061346eb", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d767bdfe-201f-43b3-ac0a-a95345f33560", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c22456b2-62b5-4f1d-a52e-b411f53bf4e1", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3204b889-7244-461f-9b57-1198c8555ec5", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9bdca36-525e-44b0-aae0-f379b507aee4", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3082ba89-0367-4aa9-8814-6312ecc85743", "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": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5a3cb7c-5c2e-484f-bef6-9c867b98432e", "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": "monthly_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"string\",\n \"opportunity_title\": \"New Business Deal\",\n \"stage_id\": \"string\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dcded59d-dc19-4597-9610-b8fd4897ff3a", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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": "d6da85e9-da9b-4fc6-a763-76cb7300acaa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "311862ac-d65c-4122-b4e7-b84991dd3390", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a86f194-2e05-4635-9d24-9680662e657b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e60047b-4ff9-4a41-b58e-4e1fa2ced5ce", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b48a0b7-f359-4b55-bc62-4e568d238fa7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeca14d7-c7dd-4cfd-b1b4-1bded8c8d17c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a8b69d2-6aeb-4fae-9694-1c7c558be7e4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e173ef8c-bcab-44c3-8246-f31a00a1c725", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "variable": [] }, "header": [ { "description": { "content": "Added as 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d644260-113b-44b0-beac-29a7e87d26d1", "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": "fd929e59-d4ed-4329-be0d-342b14d93c5f", "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": "61b1abcf-a2ce-435a-92ec-03abc8e4e687", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dc539f0-083c-497f-8857-21e0a1350fa1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f50a9f6-c351-441a-9d41-49f9c149eaa0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd72d33-c008-46e2-a42a-552f79195316", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29710e4b-6057-46bf-b4b9-efeb051a689d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7179a1e-c21a-4215-b23a-b4c6f084690b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3e0690b-b11b-4632-9a34-52d106550f1c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "571718cb-e0d2-4569-8a52-fa5749d05a1d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6677d754-dc40-40c5-8b94-7a72b4e95ba1", "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": "732e5118-51cb-4068-92dc-e196401241d0", "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": "ca1c74c6-3d5a-4b01-aad4-1ce68dd77822", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8296243-cfeb-4e71-a965-316c4cb4c18d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96ce98f5-528f-4513-84bc-90d89856f3b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f8f60a-d45c-4c12-a66d-070ceffc4ae1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c1e7545-294a-4fbc-939a-8d3f23318b59", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "989d35c6-aef4-41f0-89d8-35f091c051bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "318a696e-42f9-4ea0-bf86-6cc2abca023c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "251aa3cf-0647-4cab-a675-f0a1bcada7dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a48964f8-3e54-494e-af25-fd1ad6e7c864", "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\": \"DROPDOWN\",\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": "1f4d2ea1-231e-4ebf-833c-95769698ae37", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b28f6a3f-4c01-4731-bea2-03e2513fcab7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c73a7b4f-ee51-4d5d-bdc7-75aec61818c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c70e9d56-e0b9-4985-a42a-7dda1b41ffef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5bfb27-2668-419b-a9cd-bb70948ce190", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd164c65-b8db-498b-85ad-b2c17e96f533", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "381200fb-d898-407c-82b1-17deb94f8660", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8921a27-c6a4-4b6a-a26e-e4df569adb6e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "439c6f29-b054-40bc-ab87-ec3832eb90aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56f52b35-013f-4930-b2c2-2ea793bff5ae", "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": "bcd743f3-9434-4c30-ad75-183d9c5c4f3c", "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": "e0cab8e6-f19c-4dcf-b431-b35cf5d39c31", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd5e0feb-d4d2-42b6-9bee-a31781b6e80c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d4cf0e-63d0-4f76-b472-a646467c5221", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4abcf5-0af5-4cd7-ad65-5fd93dbe55ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a257ea73-8b68-4944-8150-f83fc411d1ec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0ef10b-3fed-43bc-a94f-f956f96a5c3d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f30a6fd-47c1-4141-b07c-a17da8381d76", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c6e402-441d-40a7-8a7d-85f83e48ab4a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd26a81b-961a-4666-ae4b-743179131267", "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": "25efef1a-dcab-4791-b02d-f1376650dd97", "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": "c83337ee-b694-4c08-900a-3e6073c04aa0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "634b8621-cc46-4ce2-bdd6-a966fa0adc34", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "119a3287-e039-464e-b374-d30f267de0b4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb3c05d1-c0cd-46e7-adba-3f65e95f6ff7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e746a4d-97f8-4ed8-96a9-18ebe80ad945", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a13853-57c7-42e7-bacf-cdef7a2f5d74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce285626-3f60-4409-b979-2c3400a1809d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a728c92c-4549-4c6d-9e65-58e55f734ec7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b73e303-4868-4c52-900c-821377405758", "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": "fcdfc07a-eb7d-4b86-837a-f61723edff99", "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": "3dec2d66-2b76-4b0d-85d3-47179588f22e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b628c0-546d-4f4d-9316-f1db30f1c4bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f56f92af-44bf-41f6-9ffd-f2902f76461a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "576f25e5-b26d-424b-bb87-618a0efa7cf7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e168d10-2b5c-4650-93f1-c2b5579f139d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed876fe2-6b87-4f91-9e51-61fe13e748c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bf9ccf-520d-4939-95b1-7e8d8bb45534", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "533fc136-cee0-44b2-9775-31fc2f8b74ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27be8f82-4fd8-4ea5-8df5-221e2370b06c", "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": "6ab03b2a-9b16-4d56-8ef3-840e68520d4e", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "332f20df-133f-4d33-8e76-7c152451c257", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9860d4d4-bbd6-4a97-b287-9c1188839f78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e2773c9-75be-474b-be71-53d8b6e9c047", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1922e7d0-c400-4ac5-a722-42a30ce2e557", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e69ea19-2392-4375-9649-725b8e83fa7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6d2d0f-7b21-4b16-914f-17d6eda0ab6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f2245cd-258f-41bb-9090-83b7faad421a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40f9ddb7-7e76-4c0f-8d34-01b33c71db1c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "263fd024-352f-4244-9e2b-e585ba1bc491", "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": "monthly_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6414abc3-0001-43a8-ab2d-1d1789d62d9b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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": "d1eec713-8284-48c9-8824-e3e65d7250e9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de92d3be-802e-4c98-b334-171d803eb822", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f78f189-996f-45e5-a0c9-27fe7f5fdf7c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c774bb5-1129-41d6-ab11-21cd5b2ae2da", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "715b42db-4564-4cce-9762-bf961b687a73", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241cac35-28bf-40e4-8b45-f4e1215beb70", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f1db03a-ab33-44e3-8f29-8b6abd832bb6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30cfb40-3d5e-4a6e-a141-92ca989c337b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e25a635a-f526-4fd3-a5bc-23906e6eec1c", "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": "7599b8a0-f244-44dd-8a6d-dc8ab1208e98", "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": "f02ce767-4f8a-4296-a5a9-40202e28f106", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac7a984a-ac73-4c69-b6c7-3cd76d7168e0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e508c3e-54b5-4a8c-9bf1-ecaace410c4e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af475805-f40a-4cd6-9a86-c7c229c4f7e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37cd9296-1b7f-41d9-8c41-00a0b7159107", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba662b05-9c4d-490e-b2da-d2f56ecf4b54", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9fb6688-65e0-4e62-9cf1-d9e15842848f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32676192-b721-4c8c-a9d6-42929f74dbe0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0170912a-5625-434a-b0dd-826d6e72c444", "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": "stage_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": "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": "fields", "value": "monthly_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "order_revenue", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"opportunity_title\": \"New Business Deal\",\n \"next_action_time\": \"2024-03-20T10:00:00Z\",\n \"next_action_notes\": \"Schedule demo call\",\n \"opportunity_notes\": \"Prospect from website inquiry\",\n \"estimated_close_time\": \"2024-04-15T00:00:00Z\",\n \"include_in_forecast\": true,\n \"projected_revenue_low\": 5000,\n \"projected_revenue_high\": 10000,\n \"contact_id\": \"string\",\n \"stage_id\": \"string\",\n \"user_id\": \"string\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"affiliate_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d0383c01-6f70-4c78-8fec-2ec8b41e7bf7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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": "a454b2c2-4f70-475a-a285-99ef09f83969", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8cdea5-01ee-408b-bd22-db9b52b6b69e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48175055-eaf6-4cc7-8eea-adf5d560db99", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c04fc7-d5d4-413a-a94b-7423ef00fd8a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8f610f5-e666-41a5-beba-f38dea309173", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c692bfc-5910-4b67-a7d1-30d9f21bd790", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43cff03b-71ca-4317-b804-850b8bfb1ce5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acbb365-07c2-4502-889e-302a6f3adcec", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "opportunity_notes" }, { "key": "update_mask", "value": "projected_revenue_low" }, { "key": "fields", "value": "objection" }, { "key": "fields", "value": "stage_entrance_time" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64bc4e0d-2ea6-4bd7-a1d7-20f6577a3642", "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": "20835067-2fb4-499c-ae4b-4eaf1f0e2851", "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": "4a15c3ab-72c2-4b61-825d-40e5b9cf8d38", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d43397d-73e5-40c2-9b65-fe56aa711bae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ba24b2f-53c8-407b-bcb8-236bc4dccac3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1317b02-e079-487b-a69d-50674da67fa6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c87d4579-14fb-4216-9600-a2197eb8d64d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc630231-6ed4-4a9f-8fe0-31ccbe2918d5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0055994-acaa-42ed-9bd4-cb9a46b75010", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bc7b54-2668-4280-a4b6-4732c926ba73", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87c74933-86ff-44a0-be11-d43a8482c6dd", "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": "6acb31ee-9c8f-492f-8803-611d982f8bef", "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": "3c18a97a-b008-4af3-bcf5-e61310782e44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2826ba0c-f5f5-47e4-b574-97bf8ea94f2d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c05b154b-f6b9-4679-99c1-c2b493c44f6c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "912f4f2f-b632-4565-92ba-ddb02c5c4cf3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68360033-80b5-4d55-ba27-5f766f21cd0b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8bd69ca-139a-4188-a694-4a035506cec4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bbeb551-9f7e-43c9-812e-91cdcfec7610", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da5469b6-35bb-4cec-8acc-4add75fc7ec9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1c3a9c4-2b18-406d-8941-c6a8481750e8", "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": "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": "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": "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\": 5002,\n \"probability\": 2,\n \"target_number_days\": 3059,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "288800a1-dae8-4598-ab94-294c97c307e4", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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": "186311e6-1100-4d42-b2b6-65a8fab3948d", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074cb522-8859-4b0f-a132-9c33d982038f", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "542fd62b-96ad-4118-b6ce-703892ccfaa0", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b221606-8e38-40b9-9e19-273191fe83d0", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d1f1a6-d1c3-4a17-8996-f24da363b1a9", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b617598f-65c7-429e-a791-9582f93c6025", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a543925e-ac6b-40d3-b8ce-918d4849360d", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "846c4540-e9e0-487d-baa7-9f5d5ebb2b2a", "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": "order" } ], "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\": 5612,\n \"probability\": 2,\n \"target_number_days\": 975,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf40369e-f198-49fc-88b1-480e7eb3b01f", "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": "c40e76bc-7a8e-4db6-b801-19448a14a3f5", "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": "86ea329b-a276-45c2-9e6b-3948db3fc428", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d37c96-97a2-44ea-9c5a-1c2ebafb15c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01be9e1f-a90f-4196-a9ca-8dc0d9d48486", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750ff47f-94bf-4c4f-8ffa-f8c6c7df1dda", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "850ca69c-e94a-4f7f-b829-d034ab73b9c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0267c468-ccaf-4f3f-889f-ab0a307ddeb8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "609887c8-0b8d-4a71-963a-23fd46c9d136", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b7bcd3-f39a-46ff-9e00-64f14d112a99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c904466d-9641-42f0-a060-3f24eed930c1", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "fdba985a-707e-4dca-89dc-969f0c87e740", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dde8046-fabc-4bbb-b485-894a3fd8d8c8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e0d3cfe-7939-4f7b-9cac-d2439bd7bbf2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c41f69ff-3223-41e0-bfb7-da845be1bd50", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236508ce-1fc7-47c0-ad74-d12517ff8604", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d05b54f-d0ed-4ff7-affa-550305c997d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48f0ce63-b7d0-4bc6-91d2-bd73f1df11e7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc97f96-71d0-4895-87fa-cc877231d81a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd5e5a94-6d47-4b2d-86af-c601fe19cf96", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c987461d-b14a-40c1-ba24-6b1339a61923", "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": "d238d07d-6d02-4bf2-87c6-22056638fad2", "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": "6cbb338b-3243-4112-ab5a-5b92023d1294", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b43c40-860b-4708-a928-50ca3dd7a787", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e9fbbc7-cbbc-4b1d-863b-4de832a295ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c8a2627-cb22-45a1-adc0-774586da1975", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d32a94b-9817-45e8-ad6f-ed02edf2839f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88b9450d-deac-445a-9119-2b877c9a83be", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16444a76-44df-41fa-bc2d-be9d48aae23b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f193b655-0ecf-4b6a-8a2b-f071e318cf76", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdf36af5-ab03-418d-b4fa-84ce5c2958ac", "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": "bbb91bf1-1321-40ad-9cbd-f543fb8502ee", "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": "f44869ae-bb2b-45c2-b156-ac27957289de", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68db8ff1-5fc3-48a9-9a17-4bd0b206e628", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91073297-4a05-472b-b2ad-08792e9541b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e076c54f-8b81-47b7-bbd7-c9f11d0caf7c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b4b995-7633-4caa-adf2-142e0b5dce42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cb4ea17-b77e-460d-938b-72ef5b18e6d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b955f8a6-520d-4415-b298-49d4a0fa9291", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad8af560-5f49-468e-b5be-910369c93aae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de67f9b7-93df-40f0-900c-be310b8d35cb", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4761d6eb-9052-4ccf-b4e4-eb2620151e4d", "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\": 2514\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": "a79e40ac-b29b-4de5-8136-aa2737516aab", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25fe1f23-737b-4e01-bbbe-db546f83fdaa", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1211450-cf9b-4b7f-a43d-92bf09a76006", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7701ec67-caf2-478d-a232-fdd77198697c", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "818adc4a-f768-4628-ad58-8ff319de10d0", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a3beb9-67bf-4ba8-8104-dfe65be27f8f", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b40558e0-6a05-4d1e-871d-214830f3e25c", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb9df25-8cdf-4c8f-b2ed-b15b945cb0c2", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08fcd413-ffea-48f6-93e4-49d279c6628e", "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": "20a3cbc0-97e0-4764-a952-1032db30b6cb", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3098c5d-6779-4890-a8d3-f692d583eb41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94481aae-3b0b-493d-b031-1fc1eb1afdce", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9a5afc0-74a0-41bd-a889-5d08805eda6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1722469-39a5-4e15-b056-b335634a43e1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4d4851-4ea0-4ac3-bb04-b1d04c678ed4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced0c65d-f2a5-41bc-8d59-8d9ab4dff2e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c3e3a9-480c-45e3-9a98-d9340ebb4ce8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3440cdd-45ff-4cc0-91b2-4adacfec5bc0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09d2cb2d-c2ee-4360-ae2e-460cb2037570", "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": "9fdf6645-0c8a-4367-ad15-0457690589be", "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": "3a50e211-3e7c-45e2-8744-b395a40e6da9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf35eb5-8bf5-4726-89ab-b81b35ad850d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64974d54-3201-437b-9403-c1d86284917d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c10c781e-901a-451b-80d1-0125cd7da5bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8933d039-d553-4956-8ac3-fccf3abc4a32", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14e1157a-de11-467d-b7e4-3f4bf9b630da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6254816-cd63-4425-86c8-ad15204272b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e65fed7-69ac-4cb2-94d5-bac3a6a250d9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26a231c5-f30d-4ea6-adcb-1a56c7b8913b", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c2953214-4021-4db1-a743-686e53ceaa09", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "449d36f8-7de1-48c0-89e5-c48b4757e80b", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe9fc683-273e-41a4-8d19-523a2178f665", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e5622a4-0a1d-4275-90ac-d15769c6b137", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a764fea0-0f47-49bf-8b30-3c62310316ce", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22c01804-68fd-41a1-a3dc-30f44fd3bbdb", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b8364a-ad4e-4183-9259-6ba4953134f0", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a70b930-2fb4-4c1c-a8b9-4f21791cb8eb", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f90f04c-296c-4bc3-862b-f19034a7d13c", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ec1c642-56dc-4425-8152-70c1ab59a366", "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": "365a629f-0da1-4791-a568-8c759c658413", "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": "c265a443-fd02-4439-8192-ccb2637a1669", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f9ed1c6-53f8-4880-95e4-b7715849b795", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecc37dd2-ecaf-46a0-9980-4d04a8e21f0f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ab672f-428a-4680-8b57-5af36d03624a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83066166-6d18-4afd-a6e1-e601bf429076", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52e3fb58-2de7-4502-8a3a-a64fa7a45a34", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd12467-5545-48c6-944c-465933788983", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5205c3a-0d09-4aff-a93e-78a8e23309f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a7db7d3-49cf-4d66-8f7c-01acc9af1eb6", "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": "6be62e1a-3a5e-44a4-bf4e-e3c821bccd26", "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": "e967430c-3497-4b96-a354-f544995bba6c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f73b342f-d738-461f-a2fb-6a0c4fbf7246", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8da05d85-990b-4638-851c-95c914d39089", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eadb6d0c-3bab-4703-8431-48ab37d2cb6e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce6f5ba-c90f-49ec-b13f-e4a0f964b4ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd73b51-b3dd-45ad-b469-d4a5de5beed4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a075c300-1e91-4f72-8046-c4684c145156", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d3f0dcc-d54d-410e-b69e-0cd8d0171528", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f93c7d4-b1b5-4e53-b615-f0ca308d0a25", "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": "2d1a6efc-567f-4251-b276-66d10c48d51a", "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": "21e1d1b4-5f29-433b-ad15-96aa701bb61e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b9eacde-4db6-4f39-8c4b-d88ac5613236", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0928b790-9ba6-4b82-af52-25ff59d2f9f0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222af3d7-093f-4c59-8d8c-9fe74dd6ff4d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbeb694e-6e91-4174-8d3b-7c02d1a4d553", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791230fb-415d-40e9-b482-b13078623ba6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597256db-fe0a-46f6-8d10-3190521e3184", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d01d23ae-9ade-4281-84bd-9a2d7357baa9", "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\": 4327,\n \"message\": \"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": "94348d9d-92f6-4885-8027-42c94ef0ce93", "name": "Order Total Discounts", "description": { "content": "Order Total Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "f70a1ad1-cecc-45b7-8c8f-03574cee4af4", "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": "177a5ff9-9e9a-4dc9-b098-911fa0d5da07", "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": "23a9be69-eef8-43e4-8bab-2d4ac7cac597", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83407288-ed0b-4553-ba65-48a8df7ee571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b77625-94a5-4ebc-bfcf-4f0a7dc504aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc89ca71-0ea2-4c38-8ed2-ddce74640b52", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978d3e2c-f4fe-4fcb-bfc0-4dc94c1700d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46fe95d2-888a-4fcf-88aa-47352907ae03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ec53aa4-c859-40e4-b39b-86dbf30f9428", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eac4d4c-c667-4ed7-abf7-ae80bda64788", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88a71b5d-e1ca-405a-bd07-b5253ec99287", "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": "1c82c95b-82a4-4164-ae54-bee933d3f3b0", "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": "1fa3c036-8306-4f60-83dc-03e645650f82", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad266a7f-d149-41b5-a180-55aa9bfa3c1a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc315f0-13a7-44c9-baa1-db521b07d1ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d1c5c0f-fcfc-4a06-ad1c-0c8fa0256838", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5568f244-6eb4-451d-8391-ac6dc3bee2c9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e48be77-bbce-45fa-86fd-ee23a34d2c0c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd3cbfc-0180-4662-b127-5ee1b1db6a1c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb329508-9a44-4317-b089-1407165353cb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86ee2c7b-9188-4697-afb7-57cc56b7d67f", "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": "2aed2fdf-555a-47b1-8b2f-e70ce7fc79fd", "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": "37e3b4bb-2c1b-40a6-9521-4f033f4dc97a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e79eca4-e90a-469e-a24e-0ea6eabccfaa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d974cfd0-bfb5-421f-85b6-dd54150c1c9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c4bf71-c07f-46a9-9483-1807e8cfcf44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "931d62c3-4823-4edc-8983-288699627b98", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cac3f74b-156e-4fc3-a557-dc64498a5090", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfa98c3e-ace0-41b8-ab3d-0c61b9c5e263", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780022fc-d29b-4c5f-88e2-256e8df6beca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8160e64f-ce5a-44be-b252-0418a7f49d7c", "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": "776ab904-e912-4f81-9af9-6550d28b8905", "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": "8267da3d-8e28-4708-945e-7a93fdcc0cf6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7427582-4770-4820-b95e-38f62d8ab867", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c18ff114-6af0-4347-bf82-97e69a1d5665", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c99e74ba-737a-4fc8-8e9d-6ac4d2e773fe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ff4ff79-3e13-4136-ba91-f6b043493510", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321caa07-f261-483a-bafe-54d0d4924cf4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd16915a-63b5-4143-88a5-cc2af76c6974", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58258bf5-3516-457c-a393-7c986ffb8499", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b195cb0c-525f-4353-98a3-24c84bc1ec45", "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": "6762b71d-a650-4d57-b4ad-efb2b500c592", "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": "bf90c80d-6377-45a6-91da-1b553ba68cd1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acacb31e-3120-40d7-906e-c7c15d3e27a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c99ce2c-0ff2-43c8-8fee-6514046bfc56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a3604f3-2d77-4107-9352-3d7f70834c42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e00384e-407e-481a-a656-eb9dd033d7cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dbe2e7b-55cf-4fe7-8840-2a6c07292215", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eec8d3d-b5fb-4557-9f2b-8643cd770eb0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7bc9517-2511-47fa-a2c8-e089594dd5d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fd8f47a-734f-4dba-9e12-9e14afffa231", "name": "Update an Order Total Discount", "request": { "name": "Update an Order Total Discount", "description": { "content": "Updates an Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "discount_value", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "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." } ], "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": "514d01ea-f0d6-4d8d-834f-78bc22c78a1b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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": "84d0fd3b-d110-406d-8472-b7945335a788", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49389702-f368-4456-9b67-93ccf1f45c16", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79254476-ec77-4fcb-b2f8-135571cf05a2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "857dfb97-7956-4e29-a83d-82bfa02aa6c6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f79980d7-def5-4fe8-bd61-0abbb2e74f97", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "664eda42-4a6b-4800-9817-f69d4618bb91", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d1acd6-c310-483c-aa12-251a3fd8e06d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b627ef7-0d83-4726-8cca-c5c910dcbbeb", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03e299c6-211a-47d8-b21b-472429f4f2b0", "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": "9717a1aa-6d08-4b56-a14f-37f0df8e324b", "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": "cdea98c0-118f-43c5-9860-1dc4bec84b29", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "347e8bd5-e011-4c2f-90a9-d5f25b39c4b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9f8e09-a452-4134-b51e-c387b42e3311", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f9678d-f644-44f0-a951-b5bcb4a5d250", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e63bde90-2ee8-4ed3-ae19-0c720feb3056", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad874f39-47db-4271-82b4-05d47b2d7bca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "421ac06d-cf0c-4114-ba17-e45c4b173306", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76bcdbbb-723b-4df0-9af3-2d7d36e451ca", "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\": 4327,\n \"message\": \"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": "8dd3f8cc-e0da-48aa-8733-b069770524bf", "name": "Orders", "description": { "content": "Orders endpoints.", "type": "text/plain" }, "item": [ { "id": "ecdebf05-5b86-4896-ab80-bde22196ce1b", "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": "5c9a8469-642b-456b-b169-b631eba1e0ec", "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": "4654938f-0dde-4507-8ed2-b34af4b9f063", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053fdf94-38b0-4e6c-a3ff-e1d251a39be8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c2dd951-cccd-4e19-82ec-d0ed15314bec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeb42e01-96b9-4ce9-a2de-e5328ac30ef1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d63695f-cf38-4978-943c-d783e1da9f7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d30ed6a-f65f-4d82-87c1-d2dd2d97a6ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9034ebc1-88dc-4d63-bb04-d059b7abba0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94efef64-d9a3-40bf-9cf1-fce2f6af6b93", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14461c8e-bd0e-48c0-afa7-960a2956c340", "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": "48c8f9a9-2ca9-4801-b0a1-a1cb96c0728d", "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": "90961fb5-4047-4815-b18d-03fc93b5e54c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3acd511-23b3-4e49-9673-8d29fccd3d3d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad52faf-ed83-440d-b8ca-6709e249d7db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "732fc7dc-edbf-425f-9a7e-8916d0be83d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1e8f7c3-a118-4cab-b3cd-271f1acbe986", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dedd214-c7d8-4d27-a905-e7d9c484cff9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8668fda-a7a6-4268-b1f9-9ca598788fbf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18bae1a7-13c0-4535-b9fa-9219ff89cf98", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce91467a-98bb-4458-b6b4-be1463225935", "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": "da3512af-2171-477f-abb4-fb6366fe1a7d", "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": "67872fbd-c724-41d1-bcf4-7b37d8b3f535", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42b4d9d0-40b6-4375-86e8-528c8742b39c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6048028b-47ed-4b72-a13b-29538507e470", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113c716e-e79a-49d9-b25f-28c0678e460b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bea176f-43ee-4b96-b358-add64dbde44f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17e224a7-db47-411a-a550-db5bc090b0f7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cfef13b-055b-42fe-aa79-63da4a17d9f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae07fa21-9b6a-42c4-97ff-72377ab1d520", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a28eb3c-d63c-4ba5-b76e-04e970e3ebd3", "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": "26ed398d-9501-4e95-9039-ef574385da4b", "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": "c4e96b5e-aad7-4c67-ab36-81999ad057c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1174f696-e4e4-4c36-9c2a-d018927ca479", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "811c0c0f-3191-4473-877d-58c5e4081d44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98b57b7-a48d-47be-8c65-25e4a96ca2a0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a59547-cdc9-4199-97cf-cd7078a694af", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fa64d33-2053-4614-aca2-e6cb338afd90", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09076aa1-7dc1-421a-a23d-67416edd3df4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f028c5ea-8080-4a44-b681-74a0bd806c8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91f131d0-6e8f-4c81-a9bb-ace41d09dd69", "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": "79ee4e75-06d8-4f75-a159-d4bdff606932", "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": "73c42a94-4c91-4348-a754-22547968b561", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ffe781-6a20-4021-bb6f-3ed4bf0fab75", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf6285d-ab9a-4560-81a8-bec801f3a4f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e71d008-7560-4bd6-8e2c-d1d65fc1dcc9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4139a13-e1b1-46bc-9581-4dc10a1230d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7ab3ffb-14fc-427f-9669-e91ef8f17bc3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38d50564-cd45-49f2-a4d8-116fcec6b351", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e0b2ea2-ba15-459e-9b39-36e38d124123", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bee53b9-f2bd-42c7-8ddd-35509ec0dece", "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": "c260bfec-8ee3-45ca-af49-30283f024a2b", "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": "c2c48d86-4bdf-4049-857d-42bc2bebbac6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92e12990-ad70-40f7-a293-b93017388610", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce694ec4-8e59-4cfa-b803-63cf75d4765b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b7489b7-16f8-45b9-9147-708bbd6da45e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5f2c973-2c80-4b66-86c3-ee96bd820f4f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88df66aa-d3c3-435f-88ef-d0ba882cd829", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3997695f-46a3-4f20-84be-0a2979da8827", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d10030e-8ca4-478b-978a-0d4a137eb05c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f17bc30e-bafd-4116-8bfd-21132667aeeb", "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\": 4578.501566253277,\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": "b98efd56-55cd-4e31-8fe6-11edd17063ce", "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\": 4578.501566253277,\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": "1fff0d77-d675-423e-ad94-dcbffc7f4943", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a18d583-6437-448f-91c0-329cec66d2b8", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53de9ec7-7347-4972-b7f5-548c9e8042f1", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06135e9b-48db-4c40-8e62-c21ea4dc8a5f", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5ad7b4-82e1-42f3-9849-64566d94a6a7", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85098189-aa5b-4b52-8df5-de6b197f3405", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0609a8-66a1-4109-af73-40825109008a", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31a6d1b7-8eec-4392-a473-334f283a30fc", "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\": 4578.501566253277,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d3c7381-53bc-4788-858c-47f0ecb81650", "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": "6e84a616-f31d-4b53-928a-cba8ce53c1ad", "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": "f1a76c5d-4e42-42ee-a533-bc1c1e72a2fe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "757ff2de-4679-4619-b7b6-5a8393f9660b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3978c970-00d7-4a0e-b94d-2028fc45b6b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0bd32a8-1134-4017-bb3d-f2c5f0ac85ab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab77b5f1-ba5e-4d0a-8dcb-285a7de45df6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b961c1c-1643-45c2-b58d-09ddc9d62ea2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791c50ad-cfd1-4153-a216-5558b5c8300d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55e6a921-b594-44f8-bf16-c574de03f4d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bd9de8c-e5eb-4b82-9e3e-2f194c6ba71f", "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": "71f2648a-d56f-4e5b-940a-b9eacdc96453", "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": "8a9e376d-2545-4c33-a195-83078e407cc3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b99b9c6-7079-46e4-b712-9fd4fe3dc679", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "687c6675-3b25-4ea5-abcb-6cca8aa857aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be33277c-e625-440b-b348-109655a4c549", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c879c9cc-6b04-4408-9e9f-00e7fb257427", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd78566-9f1e-47e4-bd41-30583ff00b95", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71897d15-2384-4837-a44e-c0924d1e652d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a28966f1-53a2-46e0-b8d3-c27eb2081e21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f9d3dd9-7b2b-4872-970e-72bf788e2c29", "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\": \"DROPDOWN\",\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": "8f119897-cd40-4c7c-8652-6215386440c0", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41640c43-a607-4df5-830d-dcb10e37fe23", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed53a83-5bda-4489-b22e-a182e968635d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a57d4ca4-7a7d-4a9c-9cd6-e83e1c7ffd46", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32333edf-8372-4ff9-9688-95bf82358a9c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c4d1ce5-1432-4f15-ab1c-b8814c5acf97", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01dfe08b-41a1-43d6-9710-e881da98be87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2c397b-bc3a-4223-bb07-1155438ae783", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ec637af-4cfb-4b68-be5d-202501227a8f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9df34c6c-5169-42eb-9a5d-05efc8e3a0a4", "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": "9d7bdad9-6046-4e5f-a176-2a7cb4c95d37", "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": "a301d83d-c8e5-460c-9bb3-1035e0dbf5c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1266d7ea-faa2-4217-b758-537f4d9f85d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acfe92cf-e7b6-41de-993f-488eefd03c25", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ad1f2e-862e-4cf3-864f-94e59ca22c68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe6f7d7c-f0f8-4227-945e-fd19d2a48ca2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c9c96b-dc78-437d-969d-44c7a8ee6f16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9449de97-ba6c-4ace-b72e-68665ba3dfb1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a7a22a-f206-436d-802e-fc5902825420", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db44e7ee-f3e6-497a-8e04-b955ded17236", "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": "6d3edbf5-eb42-4cbf-894c-3a6eec4e1656", "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": "5a2ab787-d28a-449e-a218-9da1452e3b6d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a5888f6-0a89-4235-8fe6-f56cc9759ff5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89584484-7ca2-448a-be8a-7364eadfc349", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe7ddf0-1ad5-4dc0-8b0e-e2c3b9e53391", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d38b323b-bf84-4f56-ac0e-0613cb2e1dfc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe99e456-3556-4311-8066-b00b717aa8b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "499f71a0-7199-4389-b566-81df86139ed5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64d64ee-d3ae-4dcb-80f4-6cd20eb93665", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b69f168c-ae13-4f1c-a3e1-f6ece6baf8fe", "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": "57c862b5-e330-49f5-ae10-23a5d5f8a387", "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": "0a94110b-67bf-4dde-9630-ab6043a80d74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6953f250-b259-45e1-b2d9-7f1133c4cd00", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f573b2b6-67cb-43d7-8f7f-18bd7b49fecc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84fc54ce-facd-4158-853e-061e815c3320", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99209dad-940e-4f4e-928b-394ec3831048", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b16c263a-fb9d-4e15-8efb-20fe65ce3e93", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ffee96f-6a26-4e53-8cb0-c693d82f885a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dab1b5c3-4337-4e7a-938c-ec16f37ffc60", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e61fa250-8538-47c4-9b8e-46a0565c7ebf", "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": "d93e962a-23f2-4dd4-a45c-39c4ea5ad458", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df62008c-6469-4b7e-8f03-026e73c76d66", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adfcb743-f61b-4908-9ee5-5ccfcd7f47db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ba003a3-572c-4554-a7cd-11669821559f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37d75e76-cd00-4abf-aa76-f73d7583bc29", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c70c830-7411-4e96-a8d3-9bbf57d094b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26654227-b0e9-4951-89ee-fd3709044ae6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feb0a692-6994-4201-9ab7-a4edbcf1f9a4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c42060b6-31b9-47ea-bce1-72d01276bd51", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6104ba71-b546-4209-8b26-2e8efa6d2f0f", "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": "f9c0e947-0083-46e5-84ab-7bb087de4179", "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": "294066f7-25de-4642-b78e-9a136da9790c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e982bcf-cc69-4689-bba4-f8afb616a26a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9b1e81b-0e92-47b2-a1c7-a5ff9f984bab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "456bd059-4e9c-4572-9a55-d62bfa6d5a0b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343c76a0-10ae-4d72-ac70-566b6f57a99f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "867fe2ba-d369-4e16-a6d1-d781553c91cc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ef77fe7-3493-49c7-b85a-fc867d823918", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49bd0717-a7c1-47f2-80de-f7633f208093", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "507c801b-c38f-4d58-92d6-08d4ef35117c", "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": "692199ed-5bd8-4d93-b986-9c9e26a8c3f5", "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": "37e8e498-d9fb-4994-8f6f-167d5c85d7bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e47bc37c-53e3-45b2-8fca-11be3c83e506", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bb1c49f-f8de-41c4-a6fe-84f58921bc6e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a22b5948-283e-4b92-8236-060825361193", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a2d8ecf-9737-409b-9759-1087e899282d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc19e9d-f4d4-45d7-bd1c-bef61182a981", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e5b72d6-e892-42b4-a5aa-92078eb9df3d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50603201-9b57-4ffe-846e-6e4f4f76ce09", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c09628eb-dcc0-4f8a-8440-2f83c9d81310", "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": "payment_plan", "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": "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": "ac701383-2891-4594-a0ce-80f29130eee9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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": "d1694266-b7bb-4ae3-add7-87e81bc4596b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3adb31a4-48e2-43d0-bda5-44c175734936", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbbca2ff-98e1-4abb-a0d2-1326db679846", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99594738-9b4e-4d57-8ef9-529cac930435", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "299da00e-5e44-4642-86c2-e389132dab1e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05312fea-3d3a-4751-8f2b-69cd54abb1e4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "242bf237-2049-4da5-b37b-e725445ae3db", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "840bcd71-ded0-4169-abda-e12e0a3fc2ad", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_plan" }, { "key": "update_mask", "value": "promo_codes" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc56a806-85e8-4b3c-960f-e59590660786", "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": "payment_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": "external_source_value", "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\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2417f2ff-f0f2-4fc1-baa3-9671ca11ae96", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\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": "9d147396-b498-466f-9c2d-53f84aaffd8c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20aa2680-daed-441d-9299-be1d175d044b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e713b12-1e41-4e9b-a516-3b66bd22b2c4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65142e1e-d78a-4ba3-9b4b-9085e20f228e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af03273-a713-47a7-9660-62750201e89e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75466133-9d10-4fef-8582-69fd21f54fc6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ec5b9f0-6967-4b50-a18c-94191e571421", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00182abc-2cbf-4cfa-a24e-69048b074a82", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "external_create_time" }, { "key": "update_mask", "value": "external_status_value" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "order_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "payment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_source\": \"string\",\n \"external_source_value\": \"string\",\n \"external_status_value\": \"string\",\n \"external_create_time\": \"2024-05-21T14:30:00Z\",\n \"external_update_time\": \"2024-05-21T14:30:00Z\",\n \"external_create_user\": \"string\",\n \"notes\": \"string\",\n \"payment_time\": \"2024-05-21T14:30:00Z\",\n \"payment_amount\": 4805.954574126028\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34251857-85bd-4c98-802f-5233827e975a", "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": "fade698d-641d-4ce9-905b-fbae2bc5b124", "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": "1a6031a9-a45e-4ee5-934d-4e4c1d1726a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd2ade1-5694-45d5-b4ce-9c8a6ed82e53", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9cd3aeb-987b-4c42-ba96-5593de359d96", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "103cc34b-8906-4a6b-82e9-d6730ab9a461", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd8e0cbf-0146-4f1b-af56-eaad42f3e3b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f984c71-3040-406c-b797-ab0636ac8c8b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328ef19f-06d5-45e6-8bc8-f91b786ad940", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f554f1d9-da7e-4b09-98ec-02fdcdd780aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb922ebc-ce55-4243-9612-102c0b407090", "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": "c8c8a9ea-c5f5-43be-8128-9c240700e82b", "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": "1e889eab-103d-4368-b317-fd9238548aa0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a07dc3a-9df8-413a-82a2-a6b3b4b0b0f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13bf64d4-ae96-4b0f-821e-dea3310ab5c4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f27b889-90d1-454c-964b-6405bde5313b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a93721-c555-410b-be06-d56722cf7176", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc04dc6e-5903-48d5-bd69-28d17e933c1b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be87610-e4e0-4d66-8a07-c5e473e536b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e109168-c0f1-423f-a663-12d823a43cbb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b74fc75e-0c78-47db-a74e-4756670f52a8", "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": "quantity", "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": "b99cce75-ffb3-4fe7-8ec9-ec88c09468f6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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": "f33010d2-5c66-4c37-b235-e4e7491185ee", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1162f619-5d5c-410a-a693-0a5d93bb0083", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bffbd018-d588-4e79-b482-11b629395910", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a80f777-a34a-4a83-9f38-2256954b4e40", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaee9d08-c2a0-48fc-9694-6ecb87b5af4d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6798414-4a00-49b2-8d2b-1ab7fbb013eb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1ca79db-9b32-4a24-9909-41aa73b32868", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0880b7a3-776e-41f6-aa3d-e4d82bb07140", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "subscription_plan_id" }, { "key": "update_mask", "value": "price_per_unit" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed4808ea-bc22-4655-a230-963116649e96", "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": "f58c764d-20ad-4fac-8ca3-2bee7c2333a0", "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": "68801d32-9a5d-44e8-a3f8-5ab49dd25372", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caaddd5f-dbcb-4dc1-b110-d5ed995c6ed5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbefab63-5e8e-4137-b17d-a4927d4dbbc7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448d3876-1d5f-4296-b2ee-0d7439ef1390", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95de0e13-ecaa-4de4-9f3e-5f00e16dac16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2fc4598-26ce-4ccb-a639-3f4d99e2375a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09edf319-5744-497d-8fff-8f56572678c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a25198d0-cc7c-4ba6-9026-903b411b1d46", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54554e78-2e1f-4b21-a2f0-eff8b634fb41", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "4e6cb56c-f991-4254-b817-b2d1beda455f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7cc2ac-4456-4490-99be-87dd6245e61c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bee6cdc2-5a14-437e-912c-1648c8174b15", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4fa1c7-b1e2-46ca-b937-11295b5f15ea", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "370f1cbc-097d-48f8-9711-6f0e80b83219", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4970a96-8042-49b0-b2a5-427a5defdcdf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59b592e-df78-4d3d-9564-0e2b2e767914", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27000484-5ba3-409b-a87d-1a6413b11c39", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e326fea-f757-4110-bfef-a5e5222b3b48", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "353be61f-b283-46ab-a9de-0a957075430e", "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": "d39e8fa3-50c8-41a0-824d-78a888a98619", "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": "e1ab66c8-9bdb-4836-bf64-3b2c59198daa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b887c6-03aa-461f-83d8-30a72acbd69a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d2370d-002e-4d00-bac5-cce603f9e29c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f70cbf-4e70-409a-ba7b-7dc0c801ea81", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cedccfa-616d-48f5-9ff4-63de1991ca37", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36c8fc5b-c48c-461a-9a12-a1318f66f19c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c06212da-8643-4c61-9f55-2027eaf44f99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a574be2-6625-40d7-b64a-89b5f7135a28", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df0d25ea-4d8c-4d57-858e-1aca390dfeec", "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": "4737dbbe-bfb0-4c59-a60b-512d08996483", "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": "dc5cf252-34ee-402d-8e6b-48bf6ecc80d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cdbbc66-8d93-49bb-90bc-c1e39a54e9b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1ba1882-e00e-487e-aa0d-a6e4f3ee35c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7902ebd5-a2a0-4c3c-99e3-3aaf4cec621f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488e24b9-9f28-4c7e-8fd7-30cc4747a1b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ba37e0-832d-4850-99e3-abaecbbb8711", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f4e186-4459-43a6-991f-d585a2936c1b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6735d20-761b-40c0-ad33-eaf495c1baee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5c17544-43c3-42fe-8161-558a508d4663", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "13601755-2d0e-4986-b768-0fec2c773083", "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\": 2514\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": "ca045daa-7808-4404-b174-610178eeb6ec", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9e5a63-959a-4c0a-b48c-7088fc64a8a1", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a0f844c-bae3-479a-a943-1631b3452a70", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d7ad3d0-a13f-474b-9280-2a86e414e0d9", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7e6ee2d-e25c-4d6e-9de3-d6769c851433", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3b6c375-115d-4503-96ef-681218b7f04b", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077cc9ea-a9b5-44e8-b75d-ae7117b9d0ae", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65662bf-7a00-495a-9800-60372596b08a", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "963a6d11-7672-4bfb-85f1-451b0caa9ac6", "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": "e927ff04-4bc7-4182-b40a-4dd81078dff0", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44bf390a-5f92-4366-bf73-667493f2e878", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a926cd7d-6154-4d64-a72a-73e0af5c0a41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e26c935-b6f5-42c5-a362-1090a90f2ede", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa94f7a9-e673-4c56-975e-7d31d9b036ac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0268b46-a0e0-481b-8107-89b88b341eac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c8d769-530c-49a0-bf5c-f1a2bb78f117", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c7c358-f97d-4f91-a240-cb80e748c8eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e1303f0-1bdc-40a5-9536-a5ad75b5bd1a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f074f2-a17c-4803-b424-a9e853ede282", "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": "b022ce7d-a814-4844-9c98-d4f3210e8780", "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": "dce8fd7e-65e6-4f36-814e-4fa0f0bfba88", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "899de0da-d28e-4da2-ac6a-eac47c17c1e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c6d572-8f38-4285-9971-3eb90bb2de3c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "699f943d-68ae-4dd7-9262-0c697e328f70", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbd86f7a-2fac-4f57-8859-57cd7b0f9906", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e56ad478-94fa-4909-b295-5d097c814120", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "631d0269-7f42-4da4-bca8-75c8ce6dd5d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c8f979-672b-43e0-957f-e91f0cdafe03", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "127864eb-ecd3-4baf-8462-c68bddb066d3", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c1c43d2-d292-49a5-b2f7-392108ab58de", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "041edde4-5dcd-4dd0-9b07-9eb518dda866", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3bc67c-335c-409c-974e-95a283df2c67", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7098fa56-e856-4620-bb85-30517da97d0f", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1ea26ee-7fcf-4050-9d64-299a7da37f54", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c486cac5-e2ad-405b-8331-f9bcb074f3aa", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c428307a-d138-43ef-8230-649618b7cfe3", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79f6c72a-7892-45df-ba05-a2490d2e90ff", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26448359-ec7f-4db3-a63c-3b838381e509", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d644eae-24df-483f-8a2f-c133896710aa", "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": "c13636a6-6728-4b18-95c9-162634d0ca5b", "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": "8e618a34-a1f6-40d4-9adc-a6552db97174", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34021e0a-25f2-43c9-ad96-cc5b7cb2e217", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9bcf413-5e88-4394-ae9d-26d0cd774125", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b3cb5b2-d8f4-4ff2-b5a1-25ac0854542f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cad53f5-9f81-4fac-ba9a-e90be4c55140", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4472e42-e9c4-4848-80fe-5bfec9c992cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e8b4ead-8f18-43fb-a621-8909de049d23", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a14e98-7567-402d-9154-6e9b08315b08", "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\": 4327,\n \"message\": \"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": "e7b30f18-5711-4cae-93b1-2e54ddf86d07", "name": "Payment Method Configs", "description": { "content": "Payment Method Configs endpoints.", "type": "text/plain" }, "item": [ { "id": "2d4de563-6e39-46af-87e7-ea07a64bd4cf", "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": "c15e10e4-10d8-45c7-8792-584f50d7df7f", "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": "da900af1-bcef-40db-8062-23ffcb616468", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fced6f6-31d8-46dd-a49e-8edfdc7ee71d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15146b5-ae67-4516-bdba-66cc757de0c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f786f979-2a39-4799-9177-c13e58582f4d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e21f8065-2a87-4b3c-aac3-ec2ae7b6cb09", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f10f7506-64ed-44cd-a822-b936123bc85b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be1c4c66-8717-4e57-87c4-90dbea43e7a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87cb3ff7-1755-49fc-9fdf-0f6f71833538", "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\": 4327,\n \"message\": \"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": "52a15dbe-3662-48e7-869e-578aa98585d6", "name": "Payment Methods", "description": { "content": "Payment Methods endpoints.", "type": "text/plain" }, "item": [ { "id": "9fbcb9b8-b6c9-4a8d-aa09-243b59a86180", "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": "a60d0b91-e8a1-441c-822e-06768ad9e493", "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": "fad83e11-3b89-4bd3-b4c5-28b9fad76659", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b57e132-9da4-4d49-b7b9-d7f670f17da0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c396cf-112c-47ed-903e-05b33f516ed1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc146270-4844-4f1a-b09a-f0d0966ab56b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "576864f9-9ea1-413d-a954-a4a30c357774", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4207ac0b-f4b3-4858-b2cb-89bd5cde5011", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ae87f7-46e7-41b4-9093-7f0c70dbf96e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fc3135d-5922-4aba-ab33-0d8c3b51cd56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4647bcc5-607c-4738-882e-f1461c778492", "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": "9f772793-978f-4f97-b13c-4191a20662f9", "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": "3823a78e-d367-4995-b3a0-98572028a59a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c6b9e53-32fd-4b71-974f-eddd238f09af", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d97d755-17f8-4abd-82b3-ad35f66a3a8b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21a771df-bb9c-4180-8673-a6d49b71e42b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313a1caf-16c3-4b19-a1e2-ab09aeb3e0bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ad9305-f804-4766-88ac-8eb940e5428d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7367717a-eb59-4ba1-bbef-dd0f733d36c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6792f0e2-bef9-429e-bc21-5c0960bb7dbc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b6ee420-aa81-423b-86b7-d7e0264173d5", "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": "182b8387-5f56-44dc-8a63-a921ba98b448", "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": "95566caa-80b3-4f60-b32b-365b14c2e39c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19854f46-cf91-4719-890c-9d4003990840", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7997c019-05f3-4941-8a11-0faf216e9cd5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bdecb52-f99f-4086-a671-252c22d1f157", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a17f7538-d37b-43a6-882c-716248751646", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ba65cb6-bad3-424c-b5ae-f68e27eb6ab9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f1cb91-1866-42d3-841b-090b3e082dde", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c87fe8c2-8f67-4b3c-8609-aba7defb457b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3554e22d-ecf0-4b69-8afb-8c96cb81c667", "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": "2cec3dd5-ccda-4d41-b579-97a14d6169cc", "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": "4e05e43e-c8a5-4a97-9b54-c93b3ff33c85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c75a3830-5de5-476e-8e9d-4048499af7c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f5d3415-45ac-4dd2-9886-529e0f680e54", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beabe00d-e44b-43e0-befd-8185d3a80828", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1b295f-b5a5-42af-afa2-9fe46e4758f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e61ae19-d631-45cd-b8d3-69d707364d1a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d133632-f098-4934-b252-bda14da14f07", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9bfdb61-9f0f-40ef-8467-bfff34d04662", "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\": 4327,\n \"message\": \"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": "d97fca80-f0c2-4a93-b718-fef3fb2ed867", "name": "Product Categories", "description": { "content": "Product Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "d0f211c2-43a5-438c-995b-57966349bae9", "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": "f0bd00a3-38b4-4b37-93a7-1c9dbd6bdd03", "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": "e87a281c-c0ef-4888-a0b3-73de232813e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f5aab5-760c-48e3-8d0c-d126ee1f3a1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc2fe26-3ebd-4dae-a221-f756b2e12d26", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b48dffd-6fc0-4da3-bd43-bffd3d0b82b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9df09a7c-2b04-4881-be32-018bd2ea4f73", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3fbc275-4e3d-4740-84a3-5bb0c0f70261", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c241e536-966d-463e-917d-3201f2e013e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c928844-d2d2-4f56-8eea-6404f2e87fd0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f2b6bb-aa65-4685-8c30-ac94550fa76e", "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": "1a95662c-c68a-4723-8c03-dac28e5a5ab4", "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": "4bf6ab74-6110-4517-8c80-58effa81a504", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea11a35b-7cb6-444c-a418-51d9462daabd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad663488-9c7e-4c52-953c-6b3474e15f95", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "577b0bf5-947c-4c5b-a7f6-48d512d30a7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2510e4b-d347-465e-a516-f9d0cd61583e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b554b996-7914-4600-8907-48aeafcb7218", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3314043e-901e-4878-b2de-7e51bd35c34a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952cb220-491e-4e99-911b-4f23f9ea8753", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0b3397e-068a-4e45-b395-18b8b056d934", "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": "d1897655-ff42-4a15-a2e5-6cd1647a91ae", "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": "978f49f3-9c72-43fa-8adb-6cc4b7187f8b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bcf05d-8156-4e6a-bb64-5bf97ee28648", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7d09693-be2f-4176-bbeb-217a441f6d3b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53aa8182-8425-48cc-bd8b-27d69d24e635", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481323fd-ec13-434f-bb85-c81f7d3802ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6059b707-793b-4852-a7b2-47608b0d0a4a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "021cd8f0-4f3b-4a4d-86a9-ab3dc4f4f978", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e806e3c-0e22-453e-b191-9654b3168fbe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1aece6e3-d0dd-46d1-8b7d-4094c77be2b3", "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": "01eac2cb-2ef2-4933-b1ba-f6aba14b14cf", "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": "65eeacd9-791e-4e2b-a67b-e8cb5e5e1afd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c60e3882-4a22-4867-864e-58d6f256c457", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "919785a1-773e-45a8-85d9-ce1b9b1246b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "423bf3bb-df19-4df8-9070-7435b90b853c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488607ea-db87-4b53-bb01-4131b2e5ebf9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54133594-82bb-46f7-9f42-8d63b59e4713", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f37cff25-79fc-44c3-b0e0-f876a4e55491", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c71029-f0a5-40e7-b1c0-10d842a0e4fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "398b6b6d-7d33-44e9-9204-2fb94dbbab43", "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": "5536f2ef-441b-41be-883e-d50962583250", "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": "287c5341-60c2-4028-8bbc-1d9f8659942e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a7fea9e-4ad3-4a28-8518-8a43e25d4be1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a67c3af-782f-4caf-96d6-548e6d7a802a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791e7beb-ce33-4e0b-ac91-a77da53c5cbb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79550696-d0ca-49ad-b002-bb6918311d7e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5dae58-52c2-402d-af5e-cb2d0c9f8b77", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf46c650-a185-49dc-9eaf-5a36cbf9f396", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "703d6411-0c26-4df8-acbd-f335152ced65", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9026ccf5-a1fc-4494-bfeb-3462e4936bf1", "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": "2b692058-08f0-4164-b0f8-2c1723d7a4fa", "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": "29d93cc1-a5e2-43c6-b8b9-133bc9338637", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "968aac9f-1760-4c48-9ec1-57a6208db42e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60707521-eb04-4c6c-9f4c-8daba0c0dfed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d84879c-d544-44e9-a6cd-fb7fad886fd8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0313220d-9885-457b-85ad-6261fc322b5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "188bd594-c35e-4dea-b32b-d745d696b323", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf28841b-90bb-4c42-a14c-b8909c1e2c70", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e27adb-75c8-4e0f-943a-a97746b11054", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57de37f4-e104-4527-989e-a153bfe47850", "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": "1284b75b-c655-4d39-9530-ea21bbb11f71", "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": "fe71ce6b-9c95-4c98-9a6e-1c88e0135289", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "806a61bd-ab89-4c49-854f-b87f5cedf73d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396bebca-de71-4fd2-828c-d9569a8ae773", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72c5480-bd62-4568-8dd9-8adaf406ba02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f472c6-e03c-4647-9f17-918dc9fb0d4b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac5e070c-a367-4ec7-a572-7480f6f6e659", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02deca58-e8bc-4393-afa7-a8128fff22c6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9bc9ecb-21fc-4dc5-b808-2b13c958bbe5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58cc6b2b-8a39-4489-bc5a-1d2998adf418", "name": "Update a Product Category", "request": { "name": "Update a Product Category", "description": { "content": "Updates a single Product Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "parent_category_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "display_order_index", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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": "619d38a6-a460-44c3-9ff7-16b759847aff", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50a2c9df-a220-4120-a481-af6c773dd021", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab141f8a-895b-4fbc-983f-2760fc7f1a09", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d178e2c-3978-441a-8b21-442d319814b0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db2009d-ec29-4cf7-bac9-67c89eaceabe", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f6718f0-ce6d-46bf-bbb6-840a947bae27", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ddca07-1bc6-47ab-a124-7f5a24604f80", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e977695-2b84-41ca-a1dc-e546179d2e5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd753e1-09b5-40cb-9184-a34af85ad2ab", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "display_order_index" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0a7b5ed-c54d-4ad0-bb9e-c5ea45e7e6d8", "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": "e7be22a3-a80a-4867-8b44-60776a77df02", "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": "ab64bede-477b-41f0-88b0-22ed793e027c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec67c70-75e3-4522-bb17-fa84b81a3b68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cbef7a6-a56d-4504-b25b-b9b8e25b141b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d0d02bc-f760-4875-b343-0dde845abeaa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b2d88cb-a39b-4dc4-93eb-b2e9185ad53b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bedba62f-5192-4732-8cec-84f664967d32", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d6291e8-04d2-4fbd-a1be-7e44a794833d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ceab29-a006-43d5-9772-dffdc056d44a", "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\": 4327,\n \"message\": \"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": "79a4cb0b-bf40-45c8-92d2-9827c270bec3", "name": "Product Discounts", "description": { "content": "Product Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "7595893d-5aae-464b-9277-20bd0e11f587", "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": "0565f6ce-94c9-4d17-8ec3-4151aedd6295", "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": "256c2380-b087-4ea2-b591-36ba460368d5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7b8ee2f-5f10-498c-a8f4-0ddc839fb029", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1e2789d-0105-4825-bb38-78caad075e51", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad2afd9-4f55-4f1f-a85f-eea0f6d97780", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b2ced3-4cca-431a-ad74-d43d6a767f04", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efc48385-863f-4748-afaa-e416e74575db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4592cb4-e611-46eb-a610-1159307e1a78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efe4e48-0c96-422a-be88-a3a3ecd211bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d9f6a68-86f8-42d9-828b-e527f9d8d4dc", "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": "852f27f9-d86c-4352-b04c-13b5fc38c81a", "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": "6ea8b45e-8a42-460e-afad-9f24215ee4be", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec865e0b-67f2-41ea-bb9d-49e216632ba7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de45fa22-8167-4819-a64f-96c57565aa59", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be5113a8-d147-4757-aaf5-d71919ebfba1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c6ad49f-7894-451f-bfe8-aec1990db6aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "febfb566-014c-43bd-8c4e-a0f4fb54e099", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d6c5045-a17b-4aae-8f96-8377554dde77", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "367cecc8-3677-4252-827e-79c98292287d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12372e27-bf51-4263-a9b4-beedb3f7a03b", "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": "eab1e249-e9da-4e5e-a68d-29998c5b090a", "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": "9c3c6a9f-f003-438d-92e7-c70a85e6add7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a358d36-aef4-4de3-b1dd-f4979ca36de8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5efbb22c-68ae-4439-bce3-6896618d2bda", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce726fe-cbec-4737-9803-afb29aec185f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e89ef3a-61a4-4ffb-95ab-6466ffbf3b41", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14188be-c473-42c8-87c1-bf8c1db68a01", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca63618-e7b8-41f3-942e-9644c5656c74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be341b95-dc4a-428c-b223-4344a2c43586", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71dabdef-2dbe-4c80-ba70-ba255782c022", "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": "b0583e89-00e6-417a-b92f-788fff419a2a", "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": "64dce404-928a-46c5-aa23-98f64823b50d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa10d53-4ba6-40ab-a2c5-dcba98c9dfe6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b17bb9-c95d-43ce-9272-19ea9ba99891", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbcf5c57-36f6-40c4-9849-bdaf4fe09389", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa025c8f-e0e8-432b-b653-533154060e06", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0919dac-ce24-4084-895a-76db21ee4eae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "843292eb-9e24-44f6-bea8-f5c85fcedcb4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17c7acfd-7a3b-43c1-bcb8-7fba64595431", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de569140-d642-4b64-a69f-b74d7ed6bbeb", "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": "3a8cde69-060e-4896-af7f-c7329d95d0f5", "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": "62ad58f5-524f-40a4-bc80-3a66c2ba6a54", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a639bf00-3033-4682-8a9c-54a10e2ee690", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c83e71-a0a6-439a-97f4-010757dae3e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a10637d-10f9-4548-955d-8969c7b2c48e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b10b5fd-01c2-4b3c-b17b-407f51d2ada9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea046b7a-cdd5-48c6-9606-8b75b7e9eeb2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5660f67-7355-4318-9209-e2984f1b6c83", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2353fe60-b42f-4bb8-8ff0-f38288766591", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67cf1784-a22d-46ea-b06b-70cf0d358f36", "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": "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": "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": "90cc0557-e814-4498-90c8-b9683243812b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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": "6b9fa23d-d340-4078-9a87-362bcb04ab20", "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": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42cd2642-545b-4875-9ed4-4070c0d6e11c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf24398-430d-42b4-8b10-dd529da8e46f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c587a1db-44a4-4763-a44a-1178ec088ae6", "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": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "227a22cd-44ee-42f9-8e2b-4f36c6b8bd58", "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": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c49a090-10ad-43a5-a5f0-d09aa9d8d6e5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45fcc7b2-d9cd-49d3-8a9c-7910a89955ba", "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": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c04121f-b635-4a01-aa2b-92797c186220", "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": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1008f72-01a5-404d-9ac3-6a4a44f2a14d", "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": "221385e0-d2de-4a3c-bd3a-54c3ec3193b2", "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": "6bf3f8a2-bd4b-4542-aa2e-aeab3533c2b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d54e6bf3-7357-49bc-84c5-08438877673d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61efe21d-5652-4ad2-b234-acdecf469c3f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8ddbd8d-45eb-489f-8cdf-6cb9b436c353", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afc48fed-c044-408b-80dd-05325d6b797f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c71330-59d0-48c3-af30-0a318669aabf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b22fd6a0-f085-4a6a-ad07-6e6b79c5ede9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af5f3fe6-4f0a-4b7e-b089-b974e19c7c06", "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\": 4327,\n \"message\": \"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": "947f4101-cfdf-43f1-98e8-fe412df979cc", "name": "Product Interest Bundles", "description": { "content": "Product Interest Bundles endpoints.", "type": "text/plain" }, "item": [ { "id": "5e39e5d4-7ce2-4a78-a419-110358638d7c", "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": "9c35cd4c-758f-4ab6-8c81-0e87d2171521", "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": "b76a94a9-479f-4178-9ab0-39b4a3da9b2b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22aa8729-2d69-486f-ba15-2d7ffe0194ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f16f61a6-b94a-4efd-accb-b62cebb790ed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25377569-eba7-4cd8-a414-072137b01ee1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e631f492-8014-4764-8933-221dcbb8e625", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b81ddc-360c-4010-9765-aec8a20e6d0c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1b063cf-fc13-4a8a-89ae-ed4c4132c2b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78693103-fcc5-457a-9c1c-08954b7d933b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54931a13-e621-43b9-9c0f-f8ce90388b73", "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": "aeac76ae-ce35-4fa4-aaa9-a10dd58bbb0d", "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": "99a371fe-3020-43a7-9461-3c6f5e12149e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001b5486-c934-466d-ae47-3c3d646af844", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652907a3-b0b4-45f9-bacf-2b1c1b3c23b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d50b859-b72d-4241-b491-1b3e1ed3300d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2be929e6-47ca-4a09-8b66-29c532d72ddd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1b1657-cb8b-4a1c-971d-82d6a38a9d6b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10df0231-74ac-4a7e-a045-8432f1063f86", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b45f0b2-3874-4fe9-b628-56127acd09bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6e89b13-4b94-4eda-bdae-fe29f0fe2f78", "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": "d7a668aa-2a50-40bf-9f53-26a94b25d9e0", "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": "ecb7239a-bc36-4f98-8514-55032bd1ed17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c0bd555-d19e-4cca-b096-3d6b257235f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9827df1a-6c4f-4021-a60e-15bee0a09a8f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f4272e0-1697-41f5-b4c3-6467c47a93f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28f85b15-097f-4be7-84e3-4efd26533127", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f47b4f03-4b8c-46e4-9b10-9c3be411a99f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46699de2-87ab-49cb-a0e7-5cf65bbcc7f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca62623-a07d-48c9-94ed-c5b4ef070ecc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "317ddd90-f771-431c-b96f-74580cc78005", "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": "bd383650-5693-480f-9e6e-7d7e8f907419", "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": "16d0bd0d-2a08-412c-87c7-2b8a4107cc99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48dbd252-b1ec-40de-8dee-97356093b095", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "191fcf48-8747-477f-979c-7a802a21d6d9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ce67ba-7c5a-47aa-9f0d-d2e18b87e20d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e54e43c-834a-4806-b103-336872147d2f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "175e784e-101c-4204-84d9-06846f0e34d8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cbbbd69-d7c7-4710-b9c4-af45bca35e69", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06b903f-7b8e-4c33-9c75-130b338b3613", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "744334eb-2eb6-4b75-95b2-47f58a446f12", "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": "bffeb0a1-b9b4-47d1-afca-692ff4a656a5", "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": "0433f72f-e361-4401-a36b-5356c6b66494", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2fa3835-488e-4cf7-b99a-a385183b6f4a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9828ab7a-bc14-4a59-9349-2cd4a81d0508", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14a82d7d-d927-4599-889b-1912ce057bce", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d911eaea-2584-4db0-805b-e2870a08c0b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "540e5bd9-6e1a-4594-bb78-dd6dcb6c8ea1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59a80ab-148f-472d-9a75-585324442d19", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2665d568-6616-4723-aaeb-dd266f5a54b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf5859e1-756e-4d97-b4cd-f06c3832884a", "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": "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": "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": "e8bce18c-c40c-4967-a32a-c8e1c8c562d4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\",\n \"product_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_plan_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5265df70-e192-4e68-9386-ec28857a8c3c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed55c2a5-0481-4742-b9c0-12c1a9e8b05a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9217e203-b62a-44b4-81d1-26a46312f486", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213934c2-2ca9-4996-aa4b-4e49a9332e27", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75df3650-dd4d-4636-a54f-c604af05f054", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06ca6ce5-4905-48bc-891b-2b06ef6f1bcc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "709d8b10-90b0-42aa-9f07-63e9566250fc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a665b8-e7ad-4d54-89b8-209187ed37f6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dce10bfa-a77b-4e55-b286-cec313405876", "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": "2ec1e8ed-28aa-4ad3-bbfb-a3854e29427c", "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": "cbe70718-fc53-4ec8-9c03-12e77fa11df6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b537b43-401a-47d1-9ed8-ecfd3cac6659", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90fc7291-b368-4642-be53-dd1c7d188524", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c4c571e-f707-45c1-bd2f-2820965872bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c71d89e-67a7-4cd9-bbed-a94227fb5a74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf72029-b627-40ea-8e3b-e9a5b18fa953", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb263b31-5264-41cc-a9ca-f8e73f13872f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3680fcb6-4c40-4676-95e6-c0909d17ed46", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0760dbb1-2222-4eab-9a58-ad153fc775b9", "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": "acae0739-b3fc-4827-83c0-0a665a1a40f3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"type\": \"PRODUCT\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"interest_id\": \"string\",\n \"discount_percent\": 10\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b5bb75-a181-4ebd-9a54-976cba5ac9b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e794716e-ea77-462d-ab67-1b3f5472d57f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3866ec2-aa7d-4ae8-a009-485a46178161", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "624eb91a-2ea9-4596-af93-82d2fb490162", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b30a7bb-8f31-463d-959b-70ea1a424b94", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18ec4e9-be5e-4a8a-9278-56ddd39414fe", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "166082b5-e3cd-46fe-a94f-eeba8edc48de", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "973d9347-8d28-4168-b8aa-94780e8328a0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_percent" }, { "key": "update_mask", "value": "price" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"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": "1fe15a83-43bc-4415-8223-b96f779d0b69", "name": "Products", "description": { "content": "Products endpoints.", "type": "text/plain" }, "item": [ { "id": "e7c56372-e0eb-4291-a6cb-0f25b0587875", "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": "1dd1e992-b44a-415f-8cd4-497add6b872c", "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": "c6e7a197-4092-4ebd-b87a-544e8636e7f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd3e2fd-5a39-419a-806e-fe6fd3b8feb4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "651af24b-7cc4-4b8d-9ba5-b145a6066ad0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16b6183a-74e2-4eb5-a414-0dba1836b5ae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd1f9e04-a40f-4804-8440-d47da1709ef2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205fc513-322a-4cc9-aa7f-f8d22cac2b5c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d650efc5-0cc7-4d3a-a55e-ae4a46ec2bc2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "529a0cff-2c9f-4b8c-b346-7e1cd07f7124", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bc9f0b6-6133-416f-b717-875b4a89aa52", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7233a582-c0c4-4b1c-bf56-8f221a7a249f", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": true,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea3c294-04fc-43ee-aa23-89bf09f3cd73", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1164d634-2a35-4809-bd0f-c7ab0da7cf65", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "147179b1-5500-4240-a00b-7bd5650b00f3", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a27f0a0-748a-4529-b61a-4aa8de7268c0", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e96b148-a242-4cc4-8926-5bc1500bec88", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81348205-47c1-4636-9172-23f8155577cf", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "877953d8-101d-4c90-8c7b-284ed0b432e3", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a909157-1ca9-4d9e-9eda-ef71171e07f7", "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\": true,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bd9ad56-df50-482b-87b9-3b68581ec149", "name": "Adjust Inventory of a Product", "request": { "name": "Adjust Inventory of a Product", "description": { "content": "Increase or decrease the quantity of the Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "362857ef-5350-4b6a-89bb-11d60dc60902", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\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\": true,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": true,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1471e6ab-2e02-49bb-8297-2609e59c8860", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc81dd83-5a62-4941-ba9e-86ee59493440", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7702d49a-9dba-4a7d-ab4d-e5c67a77c6f9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f834231-3249-4406-82b0-e8a8edf0b4f2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf297a1-cf04-47b7-82d3-36f3b62859a1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71fdf4a6-641e-4a97-b904-2f9dbc9933e8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b3f6bb0-deec-47a9-a8ec-9593e7270eac", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d86747f7-f1a8-48f7-9304-00558be7f3fd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"DECREASE\",\n \"quantity\": 8831\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1610ab20-de96-4c9b-9efc-325309624035", "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": "8e961b1e-99ab-45ef-8662-b8f1188cbce1", "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": "37ac8d26-180d-4ae0-ac0e-6c2e142404f9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28871d4d-6bf5-44b3-afd5-47338b583b32", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b6cd87-bafd-4227-9619-be0d30760da5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6d91732-0ae0-492b-be62-ca8fedba56ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad717a1e-667b-4e52-a6bb-817fc0bc17f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36349f19-5d99-4557-8c94-13f266033a85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4ccb7f-0211-43f4-97ec-1de7f03cf13a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4baf1eb9-7e92-4e8a-91a7-27567fa48a9a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d13634e3-eaa0-4431-9146-0717d572f679", "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\": 5807,\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": "664d2cf6-4cf5-4d7e-a23e-9634b5b49fca", "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\": 1665,\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\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 9212,\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": "33d9ce1c-5f98-468c-9dd1-79bee587f6af", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "586c4876-fa2a-417a-84b1-1fef3ae3e13b", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1d1b32c-b4f3-43d1-ba09-57cc5bddf6ac", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e476420-c92b-4a51-8bd7-5f1db7b2400e", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4cd5413-c141-4de1-8726-73ab55ca7aaf", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "851b5f16-7a4f-4529-8b8e-82b178b5a418", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e14334b-1e88-4d27-a2f0-f959bfc96d99", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cff7cb6-775c-4afd-ad1e-6a3aa9153717", "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\": 1665,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e36ab145-2a79-4ad8-938a-59e8c19fdcb7", "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": "ee7f02cc-7223-4ea0-a9e7-9fc7a510aee1", "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\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 9212,\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": "6f66cea8-4c20-4e6d-9f5c-0e54620ff06b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06484409-56be-4e0d-9be2-61c64b310ef2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46215aa0-0562-4bf9-87ee-82d63a94287a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93251ed9-0fb1-4fa2-930c-bb59959f42fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eafd36b-42bb-46d4-9e07-385bf6a20765", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb93835-8dd1-4cbd-b608-fcbb68a2c2cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb675703-213e-4f72-a56f-377e52219ed1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b88bbc-10a6-4d52-8e6e-9ad2c7734278", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a55f4e37-4845-4ca5-89d5-d2f00ba8cead", "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": "5f74e4b8-48da-4ec8-95b5-f72f3ea35670", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc58c04c-453b-4778-ac28-966bfcd6e42c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc3ef388-cbca-4193-981f-c4a1181fcca0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7166bb79-2a55-4c79-81d9-d597c8d69deb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db6015f-938b-4601-ad0f-a349e8243ff7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c69ddd2c-1966-4eaa-bce6-6959b4252571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d442e524-67a2-4697-847c-10bd9e76d9bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb22479-3c81-4504-ab19-189db4f026db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b445eeb-076c-45a8-a45f-767ac3b7030e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d774b3d-0da1-4f15-bbf9-3f348641ca90", "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": "028b0a2a-1724-4654-b7a3-c61bf69aefff", "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": "5681ddbc-f6b1-4af0-aff0-c93dfe5eca93", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241a8d27-3d7b-4da6-860d-982358826499", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "785ef1c4-5250-4ddb-922c-a1e082397a5d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35eb123b-01f2-4d5d-b5cd-26cf0be37cb7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d770deb-b060-4611-9c7b-c3b28a0f21d9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc53ab66-8a7c-4137-b859-5c3b248dd9bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb4278ca-9e76-422b-96c4-2a46500fb3c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5b2c549-1a01-4b78-b452-a34123982f2c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e14e276-f1b8-4ea1-ba14-c07759b729cd", "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": "7034166b-2f0a-4afb-8e91-d6ce34f4d61a", "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\": true,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": true,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fec8ce79-c365-4fbb-9447-27eb906b0055", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c862c566-0153-4b5e-be8e-1961c2f21210", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8398eb-cb24-4f37-b5d0-62a4ee451789", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91162cfd-f06c-4833-b6e8-d0b2c1dec25c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06036de4-9fae-48dd-98cb-083a23138a1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c667cc63-61b3-4948-9068-b676c988d39a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f3caf22-b16d-4fa1-92d2-ccb6ebdc41f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f6a3ff-3561-4215-aecb-55464d6c208a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c25fb4b-0c8f-44fd-abfc-b51f46246e86", "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": "d7fd3e24-c434-4d30-ad09-ef44174dd3df", "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": "b9692dff-7752-4841-9ede-e6cfb82c1684", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83346199-3b93-4367-948e-b959a3a6aac6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3492d243-e021-42a7-adb6-7e96584e1017", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9383040d-e712-4e75-84f2-b314b6f56dcc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1254571-835e-415b-80e2-53b82279d3e0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee33abc4-401b-4247-9afd-c3182f6a46ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b668bcbe-a95d-4dd4-8851-55bc4f962ef9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efafdae9-a520-4b2d-b3d2-fec26add975d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47fca3fe-34c6-4d22-b04d-af6288894bb3", "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": "weight", "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": "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\": false,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a92dc557-12e2-4f1f-aefd-00165dd59f38", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": false,\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\": true,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": true,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7479a227-6068-4efe-969c-79103dee248b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5e2b88f-8502-4572-a8e8-9999568a5a13", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8923a115-500a-4be9-ae1e-f079401d33ce", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799eb3d1-e287-4956-9425-66122b1a891f", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52313e1-e074-4188-bff2-b84f9497e93b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "299cc075-7faf-4963-bb59-769e3a9cb66f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b036b74-22bf-448e-9460-34b28f23a636", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cb9a482-4a32-425b-b10b-82197d6511f6", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "active" }, { "key": "update_mask", "value": "top_html" } ], "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\": 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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bde97480-b82e-4e87-a365-212c7fa1714b", "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": "d7f5d97b-1697-411e-b812-c5f904814852", "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\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 9212,\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": "9066fefc-e58e-4294-9d14-d3626f0f5854", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f02985ff-a65b-470e-acef-3090b034c704", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29e467f5-9145-4eb6-9b38-5a92bd7a61ee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79222de-3e82-4a0b-9afa-7e3d06f233da", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15e8844-c390-4749-81b3-8e6ef45988e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83c4191-eec4-44c5-b003-c7772588ee3a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b27910e-4c3d-4767-b3e4-1fa1012fe81c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7035e651-07b0-460f-8152-d38bcc8523e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4d60708-56d2-43ed-af57-ee937aca0635", "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": "20fb6676-622e-4b03-b019-afaaf67d82ed", "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": "a46da7fd-9607-454b-b44e-acfb7c86efec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13aefdb5-d6ff-406a-818c-8a61538718bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "427cef8b-fbcb-4b96-8e0e-ec97556eca9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ddcc520-2278-4b0c-9a17-0002c7f69658", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d42690ee-cefc-41bd-8625-b66311038b4c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72bcc975-a5ab-4eb4-ac31-a94d601e119c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "487804be-d21d-46ce-90cb-148fb4f1a922", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c8ed965-445c-4fd5-95b2-fb3884f5838d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfa6ef75-9646-473c-a80c-951d0d64c675", "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": "option_label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fb74f5ef-3f51-4793-abf0-c8d446df2724", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\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\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 9212,\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": "3c6eee8b-6c7d-486f-9cf2-beafacb9e26c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7c0123-7a51-42c7-95df-49547eea055d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84111a4c-8160-47f2-9076-f3afc27bdd22", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562858ed-86a2-4e8d-9cd2-bfd4d16925b2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5ad136a-afda-42a0-9d76-1d9f1965ad2b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e95c6c3-53bc-410e-a62d-c0cf427a10cc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8256878a-d677-4c5b-ac17-2e6c355f53a3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1623189f-f45e-4f16-85a7-32bb06b2efb7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "required" }, { "key": "update_mask", "value": "option_label" } ], "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\": 4682,\n \"minimum_characters\": 271,\n \"maximum_characters\": 5729,\n \"allow_spaces\": false,\n \"only_starts_with\": \"DIGIT\",\n \"only_ends_with\": \"DIGIT\",\n \"only_contains\": \"LETTER\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0231b16-05fb-423f-a18f-b1a3751d9e11", "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": "c227a392-5122-493e-a918-d5916e022787", "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": "7efe08a3-1038-43ec-97a5-498038e381de", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ab0d207-b6ec-4573-afec-1b29e073666b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8477d18-47b7-47a7-8b60-e917f334feb5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65cb4240-9c3f-4334-8db3-72e83abf4b31", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f677ab3-642a-4936-bffb-abfbd6b84bbd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86945e3a-89bc-4204-993d-bb43eccf090c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0b42b4b-cc3b-45e6-8997-e37877c374e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4e955db-d422-4fa1-a0ba-1608a7eddc6f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "080af2d1-1eb2-448a-a171-416075db52b0", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "item_label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "882f20d3-8796-46ef-85e9-3b97c3a5ccba", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"LIST\",\n \"display_order\": 9212,\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": "4641502e-599f-490d-b724-2db0ad7a2bdb", "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": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d060178-27fc-426a-82c9-512ab89cd070", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d1344ea-638e-4acc-8edb-2e36d5b57ee7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e74fec-9009-4b02-a5e7-a2c544c2a6ec", "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": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a54b34d-4aa1-4ca0-8335-7c07f42b081f", "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": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c04e100-1d08-4d46-a6b5-4fc47bf07bd4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768695e4-29ed-4882-b95a-75863321c11a", "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": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ff95219-5ffe-4c18-b134-fb05528a72ed", "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": "price_adjustment" }, { "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\": 9739,\n \"price_adjustment\": 9708.041912851526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2d26df6-5753-494f-b4bd-5076b4321040", "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": "71d54b20-bdf1-4000-9661-53285db64912", "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": "b44cd86a-3de6-472c-9cfc-97172b69e8b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c0cf1de-4243-4cf8-a141-fb1cacce5040", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b96e1be-353d-40d9-8d24-811dd13fb253", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c4b5ac-81bf-4983-9301-a99a24ca1863", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "942b3dae-ba0f-4a0b-aea2-e5544ce239cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20b408aa-49f1-42fc-a665-1c18afed59cb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30eb733b-68fc-4c90-813f-7f6447ceac1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eb4da85-9aea-4bd0-b647-31eaa3b47cb9", "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\": 4327,\n \"message\": \"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": "30918a81-010b-4ddd-91c7-1e4c9f4f7fba", "name": "Referral", "description": { "content": "Referral endpoints.", "type": "text/plain" }, "item": [ { "id": "196b141e-c8ad-48cf-8396-6b5f517f7964", "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": "d74d876a-5e95-432b-80bb-e4cf828b07a0", "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": "e33e2bb5-6894-45f4-bf48-c86fca017bfc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe0c1ee-4304-4055-931b-def05553779a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76d74c1-91aa-438f-99e4-365b3343ff28", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba4f44c6-ef2b-4dd1-a19f-8bb2def9f5e1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b72b091d-af65-409b-a090-14193ffbba35", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "822f5baa-a9f6-4d91-9e8e-27814babbf24", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8781be38-0934-4a80-96aa-9ade33ccc676", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ede561ec-98b8-4715-8eab-81a58ad3ba85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d470982b-5ced-4ad8-8566-5101ecc50556", "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": "6aa1a93e-e8f7-4089-a593-02023dd68de0", "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": "1e40f4b9-2034-4a96-8bd8-1a0eb3526aa2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9307a0c-5b9a-4e95-bddc-8d9dae41f105", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b462a974-a018-446c-af67-ed2fd58a22bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae1defda-a7a6-421b-9da9-ff8c5992d1f7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea6814c8-28f9-4a4e-90a3-46fe29257a35", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51debf63-c6d9-42cc-bd0c-659520caf7b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e996b3-cbf5-49e9-96a4-63697ffcbb26", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a254f2b-6b7d-4dfa-a5c8-a32139674326", "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\": 4327,\n \"message\": \"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": "49e7c9e4-36a7-4ac1-9fa4-7a0a68922da2", "name": "Reporting", "description": { "content": "Reporting endpoints.", "type": "text/plain" }, "item": [ { "id": "0cf66933-5951-4bbc-8ceb-532f103ca522", "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": "2244", "description": "(Required) " }, { "disabled": false, "key": "fields", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "044e8092-d378-4e91-9053-0bd93f5510a2", "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": "2244" }, { "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": "1ad321d0-dba8-44da-99a9-b79d8bde98f3", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9d48327-ae83-4364-b0c4-ffbd84cee65d", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ae4c9f-973f-4c2d-9f6b-63b6bbfd4b27", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e42cc9fe-cecb-4ec2-99b2-1f006336cb82", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "860af8d7-10e7-4344-afdf-43e7bf6a84fd", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b24fea1-2958-4531-b72e-905443b65e13", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ea8b3d7-0a76-4144-b208-bff04e4166d8", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84eaf279-8743-41d2-b8a7-df8228243cc7", "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": "2244" }, { "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9b41a49-8bde-4b35-8e49-ee27adb5e4f2", "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": "a2f45b66-a557-4d45-9455-cd762c76dc1c", "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": "8cfba109-ae80-4e44-a3f0-52592950f95c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324471fc-a393-4e2d-97af-cc1f39242872", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45a02fa8-acf8-4914-97b2-6702717f567f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a67f3d1e-7193-4b32-aa07-17969db39229", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89339dd7-7cd1-4720-a89d-f7c4287ccb40", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ddf76bf-5333-457f-a79f-6fa1cfcac266", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7527ac-f1bf-485d-823a-b75dbe26f7e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0595b5-18f4-4303-bfa0-6b2567dca65f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5c25201-6171-4e8a-836b-c8e61f07d51b", "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": "7575c03a-e455-43ed-92e3-70c62ee7ef95", "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": "15fe6601-261a-4efd-8337-d1b4bd997d8d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a49ff48-0ab8-4b2a-b0fa-f6b58f43d5c5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236f305a-ebf2-4191-a844-8d2ff4a35168", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8917436-cb5f-40e8-bc21-62d983dc45ff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc55a248-c1b7-48eb-afa7-f83a13ce170b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "302ee746-0e92-4d2f-b99a-ecf1b0cd8d68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5338b2e4-7ad0-4413-9635-965e9b12a224", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a4cc0ec-4bea-40a5-9d5f-647de0a455ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25718e32-d479-42f9-acea-9cff5e788fcc", "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": "5578fd28-c3f7-4b4b-b564-5db64a4d07e3", "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": "4b267f19-74b1-431f-8e6b-fd810201d487", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e89d82d-be83-4f6a-8926-e077e00307cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0379f50-930e-45b8-a2c0-38cf759afe8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "159c2ba3-298a-4a78-b072-b809da60e343", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d11a25ee-1199-4e03-9325-149a49c91146", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83b5d814-2723-4e1d-a5e6-22bcb015898b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b02929-4bd6-4510-bf15-d4298cc654b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9890d60c-700a-4132-b54d-ade6d588c845", "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\": 4327,\n \"message\": \"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": "64072aa0-9517-428c-918f-7ef0f9bbde0b", "name": "Sales", "description": { "content": "Sales endpoints.", "type": "text/plain" }, "item": [ { "id": "345e4569-c12e-43d2-a8b9-7296066815d5", "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": "df704717-e368-4c9a-a375-055f5a82dd07", "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": "c49c0b54-f740-4db2-acbe-3edffd991c57", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178945aa-c875-4ae8-9680-eb1a91ae7496", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a9250c-5026-4317-bb10-008bf7d98aaa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38cc9a13-3062-432f-8beb-865f7e5021c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "640eae2e-f43f-4d50-bfdc-291fe923083e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90a37c5-f7d3-4a4e-9311-7d174a19eaa9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5a255f7-4af6-4a3e-b395-ba90784721bc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1005ca05-f9f5-4185-9565-91a56e8b8e94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5eb59877-1f16-4a60-bd32-9b362251dc52", "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": "fd278a7b-b07f-463d-80ac-ffed74f951bd", "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": "f0a52f0c-7733-457f-971e-b6354da65a27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe297505-4b6b-4a74-a7f5-7902a66f2e4f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24c7953-e55d-48ea-8d8e-7aaa3f3f3bdd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1bd0c78-cfb4-4723-8fcf-e50ca8ed9a21", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecbb648d-03ee-4ab3-b6b3-ee6c70b4545f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b111186e-b158-4eed-9a8f-be263ad526b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9554f30-02cb-496c-8337-448c9b3645b9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9da1179-0248-429b-a984-27e943e8189b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50d099fd-1227-4fe6-80f8-abd9350b4843", "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": "909ddbdb-c361-4a08-a19a-cfe5b13cad37", "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": "8bf23da6-76b2-41f5-8534-46270eee7bef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff0f844-5d7b-41c9-aba0-732bd3346b10", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b8867d5-5eec-4aa3-b7e2-854b54cac7b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7d43faf-f604-47d5-b340-7fa9ea6dbc56", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ffe10ba-575a-4325-a7a1-985c41320bad", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e970ca75-2e34-4c03-8436-de68c9d34901", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562af1c5-6d37-4b0b-9d88-8f674d8ea2d4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943fb465-7a1f-4e27-be45-045450924bad", "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\": 4327,\n \"message\": \"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": "a1761c51-b131-4b7a-b921-02445a3dc6a9", "name": "Settings", "description": { "content": "Settings endpoints.", "type": "text/plain" }, "item": [ { "id": "c86c87b8-11ce-4f5d-bdc1-f9d429bab699", "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": "6194fad6-1a4c-4ed5-9cb4-c1f35d33d1f0", "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": "2bc86063-66b3-4c13-9872-4daa08f36d92", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35bd63d-241c-4e93-ad85-db5e91cb8486", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40df231e-11af-4fd5-a199-20c6f5e1c884", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad3e156d-a320-475e-a508-0aa473bd1635", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53fa2bea-c2d5-40c8-8325-d34711d4435a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aed8b26d-16f1-4331-9bdd-e83e86d97761", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19010133-abf3-49e0-beb6-14e40cfc68b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91c679a9-8a66-485c-85c2-a2e76c9df082", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f5c91ca-ccfd-48a8-9d46-874e759abc92", "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": "3246cc77-c102-4fb6-98b3-069ed5c03746", "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80317dd2-79cc-4dea-a85d-5256e3e6e587", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab1df5bf-e0dd-4baf-a32f-b1b166eeb2f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4346a16b-20d5-44e9-a965-dfeb99e34b02", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248f5901-81f8-4fa2-959e-35db2016f2bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37358bf7-7a04-4ee3-b724-5505e3df0299", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b98dc520-5b33-4187-881b-6b4e01ca59f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56546d43-9c08-486f-8fcf-e37d9f8ad971", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9418bdf4-21bf-4440-ae7b-87f9399262f1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "976801d3-033a-4d7e-af1f-c1265c58a1a2", "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": "FULFILLMENT", "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": "INVOICE", "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": "7f5fb553-f591-4b6f-ad2e-8dc4d3d376f0", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "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": "09f18cf3-b310-4e1b-8eee-cb4653056079", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aff9417-1f5b-46c2-9f2c-58e2bc443629", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ecfd94e-93fc-451d-b1c1-f6ed4dc0f17e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "412f2b2b-2613-4c36-9535-077f6b90d1d0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33affd2a-56ea-4876-aa42-3a98670362bd", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "141b171b-8d2d-4fbf-add3-3d85785e061b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f4aecb-5adc-4139-961d-42da3daec373", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6848110-eccd-4230-9b64-6e7655d681cc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "ECOMMERCE" }, { "key": "fields", "value": "AFFILIATE" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"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": "35e36f3e-b5cd-44c8-ab57-ac9f3eb32b71", "name": "Shipping", "description": { "content": "Shipping endpoints.", "type": "text/plain" }, "item": [ { "id": "902ba0d3-9143-4911-9669-2a0eaeb60987", "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": "47b2858e-2988-4141-81aa-d69e232f4b72", "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": "067fb37e-9096-46cc-acfb-781a66d43b1e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4379af0c-be3a-4756-bb11-36c6f05a7209", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6860afff-b0bf-49be-a6e9-d96612dfedc3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad5dbb37-9969-4683-937d-931ab9c922cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ce6e798-df6e-461c-86de-5a6642247947", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ce95574-835b-4e4d-b9ac-6c05729c3414", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08e4278-62b4-4dce-819d-fcf1c614fb90", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d654de0-ba4e-4dc6-8f2e-b3e5b6328785", "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\": 4327,\n \"message\": \"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": "8c09c0db-4437-438e-9bfa-3b0af218e202", "name": "Shipping Discounts", "description": { "content": "Shipping Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "36728ee4-00b6-4eb8-8fa1-f1d60fe290eb", "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": "e697368f-73f4-4eeb-8ccb-5027faa5f351", "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": "9ab1ac64-3d72-4659-bbd0-f7bf55e8dade", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85653203-6964-4015-a8f8-f8b958a9eec5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24446e5f-b203-4337-a892-e32e934c9071", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b132bf00-b3bb-46a9-9983-286ddb39e1c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc01635b-d14b-4101-bfb8-5516e8a677c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde9175c-688e-4f0c-820b-e7536023c45a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6440de40-bae8-4681-b96d-8a251cf77b0b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fcfc466-1e65-4789-9cf3-1b9092c9cf8f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e49ff5b0-dde7-46df-9e08-4b2f01c2d917", "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": "c521cca1-59d6-4020-a8d4-b4ebb6f72f89", "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": "d89f8baa-864a-4345-8ac4-d3906d7a865f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed6475a-9afc-411f-8760-5969db49ec08", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb6fef36-5407-4fb3-bb26-56ae2bdb5588", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9467e10-772b-4f14-a926-7e073699e29d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2281e1e-8da6-4725-854d-d0a30e8eb0dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f65df8-9811-4a9d-b472-5a9e80b4c54a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a9985a0-cb97-4f55-888a-afc62b03ca75", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eaaced2-a12b-4d66-bd3d-8fe05eddc06d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fcd09f52-1828-4343-aa81-63295d8d42c3", "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": "c261e9fa-e02d-42ca-a28b-ef66193b748a", "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": "6c9a916c-9b97-4042-819f-c03b43a7a13a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "821dc932-13ce-4ab6-a8fc-a941ea8e6faf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a30cd17-b30d-45df-814b-3bdf6e774cf6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "934b1d38-359e-4ca6-95d9-072a2360010f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47a13c34-9fb9-412b-af1f-890867ffa06d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ed10ec-b78e-4443-ae9e-7332416c3a86", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2e5579-10e6-4c16-9df9-5320ddfcdec5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c40987bf-215f-4508-8ebb-f3898363321f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15589fd3-5362-4dff-a183-4b697eb7a766", "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": "c301de23-2336-4412-aefa-15dcca9c399c", "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": "1cf21915-214e-492f-b845-b09539b7e56d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd7fbddf-b712-4cd8-8198-c48576760ac4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "730faba7-94ea-4f9b-8773-55b3e78ed546", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7c6aac-e455-485f-b939-2e4b19fada00", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1914bf4d-de49-43f4-8aff-7472f3cae9a3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "936da703-0722-4bc6-908f-474cbae5ecbd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f2f6686-9773-49fc-ba36-cd40257a3c78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8f24615-72f9-4c51-bb1c-565722b6a496", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d553c0c-e1ef-4cc0-bdf5-94377eb81f60", "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": "cc0c20d5-1541-4f28-869a-57fe8cf00d18", "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": "4b0bc3c4-de58-4eef-90ef-afdcb1846be6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ca80fa6-f950-4561-ab1b-9ae91f30723b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da2aa646-f6a6-4809-bc9f-fb8c21b40064", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9671f1f3-7599-4b82-a72f-fb9f286fe455", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92b65fab-09e2-4535-9591-9cdb64be9bac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "143038a0-6e97-4fbd-96e1-300705789700", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15280902-33a4-4e07-b4c3-01c8f24ba668", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2bfd20-cdfb-4956-a668-da5251db5f16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a4fb04a5-62d4-4d10-abcb-f9f1c37efdc1", "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_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\": \"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": "67cef3e3-90f0-4e41-89af-8ac166beb187", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a3dd6f-4aaa-41f3-b2e8-d2dea06d242a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a35fe99-e79b-4763-bb14-6cd29b3751db", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "282f74e9-df8f-47b4-8f88-32675467408f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42dc4f8d-aa42-4b6f-b07e-f7d9d3d99f96", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66dec31e-6036-4098-b4e7-b56db2317e50", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea37c83-bece-418f-98e9-272202596817", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17643f6-923e-432f-b542-1d2cf6c85cfc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ca03cd-3681-412e-a393-8da21983bc0a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "discount_type" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Free Shipping Over $100\",\n \"description\": \"Free shipping on orders over $100\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"discount_type\": \"PERCENT\",\n \"discount_value\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82983337-ab7e-41a7-803d-3b0983499558", "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": "1f6aea60-ca52-4f0f-ad26-297fb771d7ef", "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": "709db74c-6c4d-485a-aef9-6aafa8402c44", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f4e5839-0d1b-4e16-9203-7e8b29c0fefe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "477bc319-b707-4590-8209-7ac1674bcbd3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61144a75-d1e4-4357-9931-a2640a67e237", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5d939d-1078-4912-8a21-f5e677d7006f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1669292-4b9a-4d5a-807e-02e8d1c2cd39", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ead2aa06-8ea9-482d-af22-8cf0d15fe8f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d88cacf-ca58-4bf5-98f9-10ec7007407d", "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\": 4327,\n \"message\": \"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": "aaa0cac7-5a72-4c60-8e38-9c22ca361684", "name": "Subscription Plans", "description": { "content": "Subscription Plans endpoints.", "type": "text/plain" }, "item": [ { "id": "a95d0b28-7d1e-4ecf-8cbf-14dad11c74df", "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": "f4502526-a97d-4bcc-9af5-7dd05877a8f6", "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": "694f710a-96a4-4624-b912-d902b3ae187c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fba70fcd-f176-4e72-a7f2-8b6735a210aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d6d5c3f-2928-405c-ba93-32b414bf0249", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44fca810-fbdf-4aaf-a917-d73f22f4fe17", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45cbbc2-7f4d-464c-b380-f8939678a8ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "066e691c-a625-41ec-8018-57b23d251044", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "763b9850-a68f-4be2-bfed-f781ba355cd1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d291bec-47b9-488a-af21-a0dbcabcda87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48ef6018-7345-45ad-8b10-db3291f2c666", "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": "59051658-0a06-4976-8d3a-edbc3273e417", "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": "0118ecd4-f575-4983-a5a4-504fcea1b16d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7d59e5-85ba-4c00-9f58-1b75c33e9c24", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87c101f8-770b-458d-973a-0e5774f14c20", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72f6df2a-6648-44ee-a56f-ab53731c9468", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9b4cf5-9abc-42ce-ac01-9cf02d45f03f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c8dec60-3b9c-4ea7-a58c-2fa92c01a1d7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30221a1f-1eca-4bc9-b015-760b779b33e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a1a74ed-fbaa-4e1b-adab-ffc1e14e384c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83b371d0-e8a8-40cc-9040-72984177fad5", "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": "45e9d9ad-bdf5-4c02-9dc8-f0268bfe3b5c", "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": "126803ee-ad25-4fda-ba0c-03305d29131b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81c87649-5a39-4aa9-9861-4bb4452f17e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f30b2c-15ec-472d-ab2a-54666844f366", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0156b867-f594-429c-a8ba-4b6740e94cb3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b9eb5dc-0f65-49eb-b1d9-8cbe81956016", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f9ff44b-1531-4681-ac27-8d2b6f22d1ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a48dde29-b234-439e-a6f3-8b96730919bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34141777-a20e-455d-ac9b-afaf0edc6acf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9523a38a-e33b-485c-9a41-1bbcd914ea20", "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": "760cf5a7-648a-4722-8071-d9de839a1d21", "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": "c08cf634-7423-4e5b-9230-61c89197cde9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dbcaf74-8250-482e-a00e-46e7d11f2fb5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e43f4263-3948-49a4-971f-8b9abc523e27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a32607-a300-4e3c-87db-a08b2f28ce4e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f590113-e6be-42ef-9748-fa6c880f3c80", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "118ed887-6214-428f-b23c-b00c164cdc68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28c6ee6a-212a-4f26-b162-fea73e5b445f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d7daf2-b2ee-4739-b98e-f39a6a67a255", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab833a84-b0e7-4632-9d5c-6df395113745", "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": "total_cycles", "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": "92f2e57f-34c2-4612-b42e-fbf356f129d9", "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": "plan_price" } ], "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": "3fc804e6-6258-4545-bbde-442a3ae8336a", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1b5b2b9-44f1-4377-98db-524a9a4e43b4", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f72be8-19a3-40b7-a185-cdfabb626c27", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7180a0ac-ff41-41e9-a87d-ad68dce31fc1", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15519aeb-cf5b-4f44-be03-824e3adce903", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "458b5a93-be1d-486c-b548-330cdd46297a", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aa0a10b-2c20-4c95-9a40-92383aaef148", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bff60690-3aee-4aa4-b288-117cb1f674b7", "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": "plan_price" } ], "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\": 4327,\n \"message\": \"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": "e76a65b2-c0f0-4f2f-abc7-f4b0b03e8eb0", "name": "Subscriptions", "description": { "content": "Subscriptions endpoints.", "type": "text/plain" }, "item": [ { "id": "17af8f07-200c-445c-b60c-3b41be4a02b9", "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": "c401b3a7-192d-4ffe-a8d9-2b0811e4768f", "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": "b9f54e8a-f298-461b-9030-45516eb7afce", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5165532-eb14-4903-82b7-e027f32c8e54", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17f3312-cc0e-4235-b7d3-3b33a913ae0c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424e3b1e-3f2f-480e-8169-ea81c6184ee8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ecc797c-d22b-4153-b915-e3a1bc05297e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e9009fe-ae66-4eaa-8897-7e07e762102f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c588e9-9c4b-4768-b488-a22ccab1438a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51ff8d00-dbc9-4fe4-ad0f-453ec4c01abb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cb1c4fb-9994-400a-b5a1-910377cb7b2c", "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": "4935da6b-351b-49b2-90e8-23a0b6ab2dfd", "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": "abd48b88-aacb-4f04-b0e1-0a9b242d8fa1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526f21c0-fc61-4984-9d9f-0a1a9a5f85fb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80a5f960-d0c2-4a33-bf2c-713d529c832f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213067a8-0530-4a05-8bad-a5baa4659cef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a19f556-72f5-4938-96bd-f4461a28ea9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ece07b4-fc7b-4602-9491-0bcb40878ea4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5144f815-112b-44a0-a6bf-afcb7c96d17c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d206be1-8a0a-461a-ac10-2cfe0a4a1d30", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b3cf4de-db6c-46c6-b22e-e9c150ecd2ae", "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": "536ed27e-7deb-478c-8209-43038c3a0406", "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": "aed8f47a-1eb9-467d-844e-72603d2cea98", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ba60bb-0c61-43a9-b1e2-5d20e5f5be1d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d743ee2-9bd9-4ee7-acb1-5002dc8ee8bb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9875530b-e514-4a01-9469-e2e37824ce96", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7895a230-f326-40a2-9c44-b8ac286493a9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b68cb7c-5668-4110-84ea-3a2ad343c4b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "747e6ad5-aaf7-4818-bf25-26ef40e2d782", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d6b76c-16a0-452e-a0e5-f31376066dce", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e482e4bb-68d2-4578-8134-48d180e2c036", "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": "48d9ae62-8c0b-45c5-8ebf-c01acd26ce22", "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": "b5eb9b05-a716-46a2-b1bc-b25eafeaa1fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4eeb6cc-8560-48b5-ad71-4fec934c87b5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9e3ffd4-516f-4fcc-a450-f4781649a07a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c328736-e3b7-4d6f-9ead-66d101914b7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9880f40c-881b-4794-93b9-6f0c1b0fd7d3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814ea2e0-58ff-48fd-8efd-c1f3f4ed706a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dfb41bd-89cd-4411-ac42-3d17a3f8a165", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c8a9867-72c8-445a-a28e-c9281a983d7d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d22fbe22-d849-4bed-8a89-0853130cd047", "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\": \"DROPDOWN\",\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": "9e2927d5-4bda-405b-b123-b04fb4ca57f8", "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79d4a3d-bdec-465c-9da2-909bc6cf41be", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3396281-eb59-46e7-b17a-00e8048bb6b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef57d915-b83c-4056-b103-959e02ff0dac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "456fa0db-b110-44f8-a20d-9dcdedecc24d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1b0013b-0497-4238-adbe-a9bfc1060e0a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b5720c-0c69-44fe-84a0-cc4518b2903a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5f3c77f-fa0e-42df-9aab-eb28dc2bac33", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "590d4bbe-c5c3-4cc5-b587-a4e90ff15c7f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa8d1010-afa9-4982-bb38-c7a13097baf7", "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": "99404631-833b-4b61-9bb1-481de59f63d4", "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": "2e2294f1-5db4-472a-b449-c022e3d14618", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c5dbb99-f5ba-45e7-b112-55936434f3e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "008000b7-5c72-430e-b24f-b95460b7642e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff5e8885-7355-4193-8a42-8a25f893f6b7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68bca900-6714-4829-a4bd-9dd3b56cf961", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f58bf87-3c5a-43c5-87a0-dc75ad83c8aa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "330d9dd0-a7a4-46ed-9bd8-29c97321a737", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b6e9b09-208f-41a7-8ea3-a48442b1c5e7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbdf3e1b-c028-4e4b-82e4-4e3f66882c7f", "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": "1bf8177b-2edd-40db-b52d-feb471b091a5", "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": "d79fa5d8-007e-4dd7-be2a-b7781da862f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef7d5e89-4f0a-4a11-88e6-3f97db621948", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4160bf63-8877-4702-abbb-54a252984018", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49864a26-2798-459c-8de8-968c0b09cb0e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6feed242-10f3-47b7-a0e5-58894e726151", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045af667-6e69-4227-b4db-43aad334b8cf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbaa2e16-2593-451c-b992-44727c2d3fba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf794b6-d41c-40e6-b33e-7172e772aa6f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cdcbb67-276c-4816-857f-f09c5098b625", "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": "51dd7274-3c15-4d78-b945-adecf531d885", "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": "cafc1761-0602-440d-83e8-e63252f03a1f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd4ab340-08b3-45f5-b996-f5d1100f36b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46de6766-f0c0-4f5d-8759-a04d3c1f0976", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e909286-fe6a-4f77-a53b-ec6e80d5cc87", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2aa886c-d937-427a-9bd5-c21d56d7d724", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c60407a-28a6-4a06-9c3b-3e12fecf0cce", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "371657ff-048d-48ce-be4b-128688d6c0e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dfc438a-da3a-483f-ba94-c93d49a4c947", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26668730-4f08-410f-9c13-b6b4f8703b6d", "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": "f521059e-5ac2-474c-b703-2b4eea4e8a0e", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "800980e8-e466-48a8-ad73-a03cb8a2e9d7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c3cb24e-ca7c-46fc-a7f8-75e340c98148", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "788a4287-1d64-4f9e-954a-766fa970fea3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d925dd8-a7ff-4ade-be58-76d6690c84e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6686e76-c74a-4bab-85ea-8b6a3fbb0f0f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c8b283-adcd-46ae-be13-0d044c6348f7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58523bf-65c7-4961-a500-883fe42b2728", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e896d98b-645e-4163-8076-40832d78d571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff39191c-f514-4c97-af3b-2107ebd611ef", "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": "1abd52d2-2128-4ac0-b3dd-288f7dd9f9f2", "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": "f692a7ef-4aed-4f0d-9815-a623b424f204", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b54e0447-fbcd-433d-bed6-67fdf9139b05", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c40bd6c3-e01f-42e3-b3d3-2b87bd87fe6a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18b54db1-dc76-4963-9bd7-13a664d86400", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c170ab-f140-459c-b670-689dc67635dd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d339bd00-5bb3-4b9a-bf1e-a159277ef44d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ee02af8-554d-49c0-818c-06a2a484777a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7327b9fc-ee31-42f0-91dd-51c86fc00e8a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b49f21d-4a5d-4e0d-91de-a2456ca324a9", "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": "promo_code", "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": "days_between_retries", "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": "72714b3b-70e8-493a-b6a0-8b2e607c20cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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": "94a36fd7-6466-42aa-a473-4a3d4fdfdab7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d84099-48db-4a8e-8777-5744d27caca5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a04ba97c-2695-46de-b694-b9a616c6a755", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f63083-c239-4444-a23f-cf668e21d848", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85b99a18-9aff-46db-acf9-86bb9a4a60ed", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b81bce8-a85b-4d0e-aa3e-b34e96b89784", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c19be4fd-d2f3-4128-b1e2-0825552e7985", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f679f3ce-0b66-4318-8daf-d9e16d7281c5", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shipping_option_id" }, { "key": "update_mask", "value": "sale_affiliate_id" } ], "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7a3c9f9-006f-4795-9274-832b0633bb40", "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": "bdf3c543-7397-47d7-b903-8725c6dabe22", "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": "a9ea2408-7198-4401-9925-3ef799b5399f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c34f54b-340c-4f07-8f23-5aeb3a079615", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610e6566-593c-43f7-b5ee-880a6daec7db", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb6fa46-727d-4aa2-8eed-5ae9f782bd94", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b2c7f39-06e4-47bd-9d80-2ce29f66aeb8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59a93526-2fbe-4520-a063-086f4c1aad42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c88aa94-00fc-4c92-962e-ef75ee9bfa04", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcd7325f-459e-4b15-93bf-40f5bb57ec93", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a23d4f6-2ca0-44a2-82f2-a83b6e6c0ae8", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "26e89238-329d-4f3a-b203-e19d6770023e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce152470-104e-4de4-a9a3-49f3919e1e62", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "347b97aa-6d80-460c-ae25-e269a0de229b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1374fa88-d123-4053-95be-f8f9582aadee", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a90d2c91-0646-4537-b3d9-a612c0bc9a3e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16845edb-e565-410c-ab34-3cad59a9e54e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89296df1-1189-4245-be17-f23c5310ba51", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b3231f4-5506-4c97-9181-0caba1fb9d3e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d86afcd-7269-49c7-a01e-b061db984257", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac73743a-d01f-4924-8967-40f613e2628c", "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": "3458360d-44f1-4525-90f3-6ba33a15f549", "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": "bb8f0e48-1325-4e95-a4c0-3506276de2b3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3446c380-841f-4f39-a728-74fc0be50f32", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9da2200-4945-404b-926f-b40788ee8232", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "929217c1-2144-4cc5-859f-d05b1dff75ba", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c14d1e55-72a3-4c12-bec1-c15d890fe649", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c6d26ab-eb49-454e-accc-3f017b786a28", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d1e97ed-f0ce-4450-9d3b-79d35c0f0503", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84e49ab-1fa5-4d0f-a31f-252734ee3205", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5890af6f-5f40-44cf-9430-a6ffebcc11dc", "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": "be515b4a-18b0-404d-a8a8-ccd01658804f", "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": "09f7ee6f-4b6a-4bad-bee6-a28d140b5c99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3522d37-09eb-4b3c-ae68-de59349bda3b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6706c90e-5f94-4b2c-8a2f-987afc81ac70", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74a11c66-91d2-4414-ae32-b0cb00e27adb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb34c906-35c8-46b8-84d2-93d9f466da99", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a001f0c4-c945-4eaa-b6f9-be3ffe6be189", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc600ccd-db77-4f15-9016-d8220202afd8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ea4b44-7515-493f-bf95-8f48e7d574de", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a3dee71-ea3a-4042-916e-50609e7ebdf4", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e0488d4-000a-4324-aacd-0dff996ec9d3", "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\": 2514\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": "4bcfa9c0-421e-489c-b3b0-a27dc2cc95d8", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9b68906-d5a6-4e21-ac85-f9bbf6122ba7", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e6116e2-ece2-42f8-9158-6a45e18f4b85", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a97270-854c-41a3-af1f-61b0fa532942", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82a6859f-6638-4906-8631-72487cbf8f0c", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe39dbc-692b-43cb-9a21-674edba9b424", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca54db4-c4f2-483f-a969-243624161b0a", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08a027ba-487d-4f70-95e7-9fdb2001bd53", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70671ee7-cfca-4f5f-8b98-8c9b8a7e12b5", "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": "cccd998e-8ee5-41c4-98c2-88b62ed15d73", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d777f1-aa44-4b70-a34e-25412eadad74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f3b1a3e-700d-4b49-8182-817c89ecb153", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22473074-47cd-4041-8472-76f509246263", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6613604-46af-4826-ade3-8f439963ff4c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c16175ba-1ae2-4296-9c4d-69097de406b2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4883a62d-50a4-4640-b089-838d6d0db941", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c05ad82-df8a-4c45-8802-a93b721948dd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e7651c-3d50-44ee-93e6-4194cb25a631", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1662165b-9d03-480d-a4d2-69a7be7e4b3b", "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": "7cfcace8-eeb6-4216-a1bb-0f1d59a482d8", "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": "5f825960-d1f1-4373-b22a-9b4bde5e956d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfe89320-90e5-442d-b183-603ada17d495", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d22b8111-9bc0-47d4-b614-21f9d8f93f82", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "795eb544-4f79-44dd-8bd5-c998b3b4a374", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f071363-956b-42ae-a474-e10b9d897f58", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c8c3619-1944-4e22-9f4a-32f837e7436d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "096dd395-cfba-4583-bf77-58aa4c1ccd89", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1834ec2-a627-4e43-afd8-309e60864c3a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "149d3c30-fad9-4adf-b41c-d1b2e9af72d7", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c6a6f7e-c9e8-4fd4-947e-702d11b2ac74", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0950f562-42cb-4a81-b174-d3557bfdd775", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2521c9d-fd59-4892-b1a1-7c7afc9fd503", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ec82300-089d-48a3-a8b4-75b0571e4f51", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f122a0df-c37f-438b-acfc-9b9cdb2586bb", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "994b12bb-7c77-436f-8f0f-97f608817316", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b86e407-6691-4675-8dee-6cb027091f29", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4709a242-935f-4da2-999a-9af9c4001dda", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78520247-31a9-4035-87e2-b9b6b895949f", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84f17265-cc75-4b6c-a623-0e862ec15c2c", "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": "86b8120a-da33-49b8-966a-a27b43975127", "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": "fa4a2029-9191-4c4a-9789-aa376ed6b593", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "346d91b1-f23f-461f-9e67-e9764a5cc3a6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f993935-c815-47dc-8490-c34150df109f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c77073b-693c-45a4-a4ac-bdb08b967b61", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f46b857-27f0-4303-b82a-11d666ddd9bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec31e937-2540-4436-9081-ea99bfc22ee5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a60d6ccd-7d6e-4bb3-bbb5-e6ee49e669a7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f520adb8-b204-4e63-aabd-2bd840d1908f", "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\": 4327,\n \"message\": \"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": "b5629ec6-f357-4b87-9683-1af213d6cb54", "name": "Tags", "description": { "content": "Tags endpoints.", "type": "text/plain" }, "item": [ { "id": "aa10107a-a736-4a2f-bc34-984c17407094", "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": "480a3e99-f5a7-4c2f-a356-0b36f539f386", "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": "818d01ce-2120-40a8-861b-e84a4aedfa4c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a9800d5-ea04-4f29-b595-d86b95ba0e8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a276308b-94bf-4b0c-9a39-e92ecf0d724e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c0ec55-08bc-4120-8187-051a29e4e5ac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e65c98-54de-4d7d-8047-e00b33995af5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146c3d33-f118-4cfb-b1b1-f42903f0ddab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88fd413d-02dd-4e0a-8182-992861e9bb49", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6c6020e-84e4-4428-9cdc-ad460f38534e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e53c372-6f59-451c-87d5-4ced93901a6d", "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": "58803bed-05a5-476c-823e-4aab49a717e0", "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": "d7784304-a208-493e-9c93-b5fdfa7c6bb5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dc89be4-1fb0-4350-a70a-6d10df8446e8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b758d8a0-bcbd-492c-bac3-433aa8292af5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "345953ae-819d-4203-b9bc-7e52be41bd0d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2991371-5066-4713-9902-9bb7f6983cde", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3137e06-2a1c-410c-b50e-c7877457396a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd302ccc-e46b-4f88-8091-99f6dade0805", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e80acc51-31fe-4b56-8943-614682ee2fe3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a71a352b-9eee-449e-b0f3-1c9fe0b1b898", "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": "10b0986b-0cf2-4246-8d5f-6cf80910a627", "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": "e7f943fe-740a-48f6-a670-4ebc55353ad4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5a3403e-7920-44fa-a53a-5387c42a8503", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e38782-31d1-4525-a45c-0c5839539c71", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca7435d-32f1-46db-97dc-c2fa474bfbd8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d4410a3-6279-4622-84ef-e4a69cf0725e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b42939-ecd3-4a47-8a3b-ce1867216e96", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "066d133f-a954-405f-88ea-d1af15b3ff6b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e642e92-e508-465e-906d-754d1ed8ed73", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34c1ffcf-0810-4b20-b766-351d14ef54a6", "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": "6f09e6b5-2999-4965-8f41-f1dbe55aaded", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "348cac07-7823-41f8-86a0-9f41f2a634fa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41c76b91-4846-46d2-aa79-d78f1c7216b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6fb685d-9e6c-41c8-8b50-57df664e48e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7326386-67cc-4836-b56c-89e41424a85f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f9c7eb2-def6-4142-8cb9-fca48028d9e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62225dea-e5e5-473c-a152-4761e192821a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a644048b-3522-4bd4-8823-4c89fcaa6440", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d927a42-24ea-457f-885f-aa0b269b36f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6b9033c-e01e-493e-af12-dc0d74b5384d", "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": "883f2c74-71dc-4ca5-b7fe-2b80c55bae7e", "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": "1d6ec805-0aa7-47be-a35e-e0da2eb3c8be", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a9a289c-cc2c-42ff-a84d-ac537f34ca00", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cae51b1-10c1-4552-bfd0-8d3792a39a3b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca3d2da5-a102-4498-a0ac-a7b9763e23c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5c5cbd4-ec2a-402b-9182-b0e239394955", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "807c1481-8e5e-46c4-b621-7b3371c3d6a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dee29af-a17e-48ba-a8c5-a9ca1bfdadab", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff6df23d-4fcf-4017-8113-771280ab52ca", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d8366b3-1d13-4141-b275-e68e625fe554", "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": "7a7f05d1-3372-4313-ae87-a9a6137a1379", "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": "fd773d78-69db-4cdd-9276-53c8dea42827", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04464b33-4e7d-4cdf-981a-d9cf02c81935", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d73f6619-958b-45b9-bd9e-9bf8e2b263fc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a6d1e3-3840-41a5-ab42-3c6d113ef9f6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c769f4f-bf19-4e05-938d-95d770456359", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca44c200-83f4-484c-893e-2f285c80e684", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e631ef-ee09-4a39-bb0f-5e1fc12fef5e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58566b14-efd0-4f6c-b5d7-a7967728ab47", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "597a4d6e-bafe-4425-ae7f-5f620c0f5085", "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": "cab92975-b294-40e9-9728-a1447a4d9913", "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": "d8370004-240d-4564-9df1-d2fcb57593c3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e7caf8-a0b4-4910-9fa6-baf011f13be7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc562957-c7a3-4669-80ac-d0a963280ff8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69527dd-cb29-46ca-b2e5-98d8c6ee5190", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adefcaf9-0ba8-4e4a-8438-3454067da954", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c47a6bc4-a0ed-49e6-975f-7a52f5f1018c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e05181c-6218-4373-b3cc-b35608a27d0f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d86eba1f-416c-4cbb-9cab-497657c4b8d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52a5c289-37b9-4376-9e8b-1b5b2124c714", "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": "4640af47-5ca8-464f-8187-ed090a274461", "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": "083963e3-c4ff-46f9-958c-5d472d84906d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd2ca86-6055-48ca-b724-fa961a8bd292", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc9736a1-a19f-48b6-825a-210a1e612bb0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9004c6-7a7e-4aa1-8fb9-acdbdaaab406", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f439c5c2-1241-4954-b35b-5985398e1ffd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "513a9f4b-8d3c-4505-8d64-41b89ae48048", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05b9367c-882c-4f8d-88e7-c1a16909a37a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d6b4a0-1e56-43c3-831a-953c0c6ff2e3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25def0a1-fe94-471f-b4a5-306ea46e3d62", "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": "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_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": "97647b31-4763-4c69-9233-bf19307be386", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n },\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240d09d1-157f-44c4-b28e-f4d26aed69fe", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c03ec0a-26ac-4d34-aadc-682ff576ff10", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f80192-73cf-43fb-9d42-9d84d0158e56", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b48272-8d08-4315-b4e3-a57be3e62acd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c464ff0-84f8-4c4d-8229-3abab64ed982", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17da14d7-389b-4446-b3d4-0c4d16b3820a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fae8c13-6039-490a-8cd4-05cc96a519a1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db0d9e60-92eb-42e0-bbbd-3d8d0fd3ce75", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "category" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"VIP Customer\",\n \"description\": \"High-value customers\",\n \"category\": {\n \"id\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53db5203-c8c5-4257-9359-55b3daeef067", "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": "583bc3e7-f975-4160-a584-a8188280bde5", "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": "c5af3906-6143-4658-b8bb-b3fba8abc78b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e3a692f-66cc-4923-a776-0190f86884b8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee3f102a-078a-421e-a9a2-a4f3cb134588", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3d0bbf6-64c4-4fe1-91f7-3e13ff0c7055", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dae8df47-b484-4485-b82e-4a2a3c57aed2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60601d53-6156-4331-8a05-8c08002c812c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77f4ef82-e26d-4c87-867f-b59c093c7fdc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "244fe9f7-b016-4e73-abdf-2e601b7a567c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20476f73-4f10-451d-a03b-554dc8e37918", "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": "8b809ba9-292d-4eaa-8d65-60bc798ee666", "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": "58e65ed0-eb38-4ae4-8d28-268d7f97cf9f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cb1b1ca-3ff5-4c0d-839b-94b28d99c2fe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b50a1b5-5f59-4a9d-8de5-611096ec1bd5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a853f066-4534-4e96-9544-59f408a7e0e2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5600ac-e608-4c00-a9ed-ee72b8aea15c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134d280d-379f-4d65-8a71-a17fd4bc496d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db88b6d-ab08-4634-8136-fc690166dffd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2181ae21-554b-4c66-b6ee-78180fcce43e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5772dfef-61fe-40e3-b1b1-66e10a585bc1", "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": "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_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": "a4a5cce1-a454-4fe0-b101-f317077c4a7c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e292125b-3562-4500-a0a7-cc1e418ce46d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01002804-6221-40d3-8c5d-5f31c95fc7a0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62077af-97cc-4b9a-af7d-d44a460d1a6c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ef6ea5-125a-4fcd-9932-07791131c6a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b6807cc-845b-4b24-853a-b781303e2aea", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "436a2bfa-6449-4364-9dc5-e8ed16fe4573", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3590cc-3382-47fc-bc8a-bab9afbf67b4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a66a77-38ce-4c1b-9d7d-bb7e5cbdde73", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "description" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "520f03a3-6cd5-43b9-a3e4-c66f1b1c3e63", "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": "274c144f-3a4b-43f4-870b-d79e23f10350", "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": "386d922a-3d0b-42dd-8973-7369f20271e5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea81e111-f629-40c1-ab8f-45e5c6fa4af8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe5b56e-97e3-47f7-b9cc-a7ea9015bba5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fc6f52-9b85-4ca7-8699-820a60efc5b0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca02cdef-457c-4417-a99f-671e363619f2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66f3d0a8-abbe-4501-999c-41f344791dee", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeb11fa0-5d74-4d7b-8feb-ee81a169cfae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "803daabd-676e-4f79-92e9-6d74f82d0a27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76f3c992-7456-46fc-ba9f-66a534a6d57e", "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": "69dc7fb4-95d9-4161-b097-83b72adb8554", "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": "1fc64b9b-c6ff-491a-b2dd-920251e8545b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36a5d431-a943-4df4-890f-6b37f685ee8c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2c3e59-06d9-4868-b02d-a124b7eb05df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73460a29-f6e1-41fb-a92f-db0f382528d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f56b1f-9ae0-4ab5-9291-c35e5b91a7ea", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15229566-58a8-4bb6-9749-90c4163178cb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d309749a-3705-40e1-9122-52cbfef8714e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6689990-9bb0-4f4f-8930-29b933b5404c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ade174a-db56-44f1-80a0-e8d2f0b832b5", "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": "d318ca9e-178b-4580-86aa-da9fc38d7b2d", "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": "909907cb-d795-43fb-913c-da6df8b3f212", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "285ddaf2-a6ee-400c-a7a9-1027b7e9bae0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "660e0e8a-f02d-47c3-b258-ea1601567e60", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc6f142-b6c3-42c7-ac22-b54b66a97c69", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205dc5b3-e43f-422f-a6b5-bae73902b47a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3baf71-c655-45cf-be73-961c9c359cb2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93e9f27d-4d89-40a8-b9f9-6aae92f20c1f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cc79e23-3c53-4e7c-bdda-8097d4bd8f3c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ec6d55b-c82d-46e2-91b1-c69f8d0def1a", "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": "70af5a1e-d160-4961-96ce-e3e67066d119", "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": "48e36468-a325-4c59-abc7-1c4cc218b54c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dddac712-e045-467c-81b2-62ea2ef34bbb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a855e4cf-488e-4a91-8172-da7a756e5565", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc6979a6-936c-453b-a68e-66c237d29b0e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5b96dee-8f1e-4b36-9240-4df5ba55ad9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ee632f-7dbc-444f-9999-810cd84ede85", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bdc1980-2b18-4830-90be-887dbfe956bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c045725-857a-4464-9570-26edb78e762a", "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\": 4327,\n \"message\": \"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": "5ae4dfa6-bab0-42d9-9fcc-341a31eabaac", "name": "Task", "description": { "content": "Task endpoints.", "type": "text/plain" }, "item": [ { "id": "b06b1a5b-0894-45e2-b3c0-c61dcad9d07a", "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": "9a1788dd-aeb6-4bf4-ab27-94026afa5052", "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": "b5c313ac-9095-4a1a-b9f2-fce89c0038be", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f761ee6-745f-496d-8da4-971bc40a5bf1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f02951b3-8a6a-464c-8588-bfca0939c9c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e968585-4e8d-484f-a297-e2b8ea112d2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69cad63d-4fab-4969-abb7-838cc1f30b7a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08285086-03cf-4b31-adaf-8ab121375a91", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3f81e6a-8584-4d34-9790-a69e03e80778", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b002bc7-eb6f-444f-b90b-87f68e8e499c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34f7df1b-cd49-439a-92cb-c8f700ac9116", "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\": 120,\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": "8f47ec36-ce57-40bb-b5a5-7640ae416d64", "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\": 30,\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\": 10,\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": "3fd3c8b9-56e0-4f46-95c5-7b157e1bf410", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89036e5c-28c5-4ddc-bc40-d17798106520", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae14d78-fcf5-4d14-8226-99a3eb7cd4ce", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39138265-ac76-4365-a720-3e87167fa21d", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d5fa38-e7c3-4c06-a6d6-b1209f49cf97", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385f969d-e492-4443-b68d-e0475d325d79", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0509859-45b3-4dae-ab84-5cc675ac1952", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adccacf9-4e51-4eb1-bcc2-773c7c05c6a8", "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\": 30,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37f9d0d0-4b2f-4ed9-a7da-a1d574959402", "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\": \"DROPDOWN\",\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": "73da24c8-195f-4d08-bba4-bc1e34c5eb10", "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": "d5fa1ac5-4cd1-49b2-a73b-4c5be4f7d2e4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d1f2b20-9b0c-4a88-86da-bd3386398a32", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95b3431e-918b-4038-bf9f-d7a416320f74", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c3aa20-9b34-4a88-b1ff-a21b504e3f3a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2202cfc3-8cad-4911-9ff8-a6556be71b49", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af2531b7-752c-4f83-a338-b44459316440", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "137974db-4253-4cbe-86c0-19ca931f033b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31086f26-d7e5-435c-beb0-1dfc103288c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b21a451-a885-4941-a4d9-ef6183d4794f", "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": "50b43b61-b0b4-4e7f-be46-2383565720f8", "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": "c5816719-3d60-4cdc-b37f-1b59b17f2c81", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af1e16d3-0b45-4dc1-8e82-3aebfeb28550", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "583871a8-9ceb-4fcc-84c6-05315464b174", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e68438c8-221c-4b0f-a54a-7019546353b1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f9bae82-440a-4068-8366-1fa10029dc27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6836937c-2226-4a4f-af8c-2a8ba56db39e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00d3e100-bc64-4a84-9ebc-93bef2e6116b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73ba5e25-fa1b-4b59-b429-92dae271ec3b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f07d8d4-49ac-4b72-a47c-0629c1be482c", "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": "e56bcc18-ac21-42f8-b21a-98c1def84f3b", "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": "0a8198ba-fa27-4704-a30f-35f2a227003f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9a8fe76-38e3-4e7f-9ff0-aea28090696a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4a2829-a166-4683-857f-1718947ccbcd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09adc803-f010-41a7-901c-0b9a9d5e36c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3144a546-95f7-4662-ba6b-fb4a197198bd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9cead2f-1f9f-4304-883c-4cfa9c2baf13", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a19a9069-4ffd-4ec2-99fc-b155c7fd6026", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c71887e-bbfc-445a-a082-cbd96cb6e571", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25dbbf06-f21b-4faf-b694-bd74b7e63c7c", "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": "fba5cefe-d752-435d-825c-3efa394e52bc", "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": "0f14a544-ecaa-41a4-826d-79ada0f580df", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73b90e11-b389-4399-88ab-300d405675c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2e48e40-a3ac-4fec-a246-14ce1f208dc4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc7db491-d70a-4da4-b2e0-66923eb2bbac", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "096b3e65-a0b6-434a-ba52-1785f85929f4", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "519c864f-e2d0-4e1d-b61b-683bf3d17ab0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fdfebd8-af62-488f-96de-a06c86c6d292", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b0442e6-c504-41f6-a804-eac9eca25f18", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfbebbac-efca-48bf-81af-52b2f758602e", "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": "084a93c7-aa60-45c1-bca2-f361a8b06c4f", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d4d5d4d-f883-4770-9c4e-70e6b953c226", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8496d2a-86a9-4a3e-98da-3271405ca2a7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cb7620d-0d2d-484d-a059-11ea0d8eca42", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd48de9a-9d9d-43f3-a79c-a765fc3ba3e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d7207ff-6b55-46fa-9a98-4c59e1aa7664", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56427de7-7ffa-496d-b76f-a7c844ef7e46", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76623e4-6022-47c5-b64f-4a32ef2fe46c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176d828e-f0c9-42cd-9809-9846c297f989", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a8e594e-7a50-40e2-a33e-0f422ca53e93", "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": "12ec1a13-5059-4557-b32a-923abdb4d62c", "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\": 10,\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": "403e5294-1122-43ef-824d-94103f2fc865", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5fc07b6-3f14-4961-871e-797943343ba3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1a61d51-3d1e-4c43-81eb-50ccb29c3123", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad980abe-e54a-4c0c-a543-5ebe392c535b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60761bdc-27c4-47c1-9c09-57eb41ec0b95", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ce08b5-7f0e-4b4d-b076-7f2e03d81b78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96258469-d30b-4266-a6e2-bafcea62402e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51908e92-ae94-431c-8dae-b71ac2f38b68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1aad1ce6-0ab7-4e8a-bf66-1e753dfacbb2", "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": "9bda79d2-b0ea-437a-b741-f2879738b26d", "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": "86f8aaac-2748-43f3-a8e7-b404b296d185", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43b52ca1-496f-4985-adc9-9202379dd231", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82f20968-1a22-4dc3-a764-c7b02fae55ef", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be0a2837-a24a-4aae-834c-171e518cfecc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b0dfe0-b664-48b3-9f1d-31fc0e58c2fa", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81ebd8f4-3787-4a49-938d-439a3d28ac26", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feb1213a-b50f-4293-a1bc-1cad16116ee8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d654b60-088e-4a9a-b283-0ea35418aa27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41fbafe4-7d5e-4b36-bebe-8f9396a54169", "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": "assigned_to_user_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "accepted", "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\": 1440,\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": "bec71cb3-e794-42c4-9c40-7c99b312d361", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 10,\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": "a681c1e7-104f-419d-9cf3-01e70e31ba69", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de48b2b2-9fa7-4461-9a5d-359b25e155e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c81195f-555b-49e3-8e0a-a86a530218c3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a5fc34-f115-42bb-9a08-7f91fb37982e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ab20e69-ed13-4c76-b92d-6d0cce5c13c2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ed6c6b8-f30a-47c6-b5d5-f89d75657c73", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f2c3a5c-0768-4b0e-a0e5-a0772f0f7214", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f86a91cb-fbb3-4037-bac2-038d0c01d98e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "id" }, { "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\": 120,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0dc5530f-8429-4489-9e17-a29bfae805e8", "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": "154333e2-d2be-4722-9413-1e0f4ab0a2e4", "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": "9759fb30-8fbe-4d1f-8c95-bab8179b8aed", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3f526f-6071-487a-9881-eed53578a14d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeb7e9cb-606a-42f7-8e62-eb517367695a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d377df34-b8a2-45e9-b12b-6923864c8942", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7602d7a7-5f45-4364-b1b5-a19a11e7d2c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "227dcbd6-67f0-4e13-b49e-7fb14bb31de3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80493a45-28bb-44b2-af9f-bb31173cbd77", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa8ee55-0fa4-41ff-a285-e70e2f47ca78", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa90ed4b-9f52-423b-af17-11f7fd517e9d", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "873d9be2-761b-43c8-8e2d-5e97760004df", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": \"ORDER\",\n \"field_type\": \"USER_LIST_BOX\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5c9f6d4-a28a-48e4-a968-1ab90a9f5d61", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25a751ca-0571-4735-ab13-e0383c538a20", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7def3d25-2b4e-4519-8c0d-5594fde66b55", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e8f65f3-15e5-4508-8349-db009a68b8ef", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e3e3f69-7d90-4d14-b7a7-1c0de00578f2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eee0f36f-4247-43b4-87f3-33e972f4297d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4978b59-5cae-416e-a72e-119daf4f8a05", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6788219-b573-4878-9214-7a80d4eace97", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "group_id" }, { "key": "update_mask", "value": "options" } ], "variable": [ { "disabled": false, "type": "any", "value": "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0041f401-76f5-4ba1-887f-c477f42359b6", "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": "30bde353-56d3-4eaf-b206-1941e2ccb3c5", "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": "2da205c4-8597-4e4f-a2c3-3bf77b146023", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d3300b-9d87-4b48-98c7-26fb8d36b7c9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d0147e-368f-4d1a-88f8-3385c3069440", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb800b8f-16ea-45de-8810-6c69a4222972", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a776440-09a6-4979-a321-e5b837595982", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32375270-2e5c-44af-835d-ab541f474dff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e3258f-0fb8-4103-a8e2-5b5f4af704fe", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b5431b2-94d5-4a99-bff8-b4218fe5decb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91e0c709-bed8-4800-8b94-84ff3fa328a3", "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": "a1b677d6-f7c7-4d7b-9003-a73f47ad72d7", "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": "aa503bb5-035c-4cbc-879a-b874826c4f2a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "699f00e1-6b83-47b8-952f-309ed0fc55c7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7893e8c8-165f-47d7-b130-7ad6fadc7e4e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25324a15-f300-4c2e-bf18-f25ddccd65eb", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1482d8b9-18e7-4372-9590-1259083a82bf", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bebe67d7-d223-4005-b69f-44d33c4ef470", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a67047a-4f54-493c-a458-fd0988dfd5d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c89ae9d2-3ae6-4de3-9867-e6b61dbd280a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fab8af4f-7e71-4021-8943-1230701fc3ce", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "610305b7-7b4a-442b-a989-d12c564ba19c", "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\": 2514\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": "63bd2010-f75b-4358-8e73-c657fbe0ea05", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bf4d227-08da-4124-95b1-feedc26d9baa", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b12c3734-7710-43d5-85e3-301a8f80f5bb", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fc0dc50-a0c2-416b-92b1-142724204978", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79bdf9ef-20ad-4aa6-b221-160ad8942dba", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4e6e8a-be35-4a88-8dd9-3313b3d20d92", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31763bf0-82a1-4f75-8e60-5201e3b6ec69", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6200125-103d-42c6-b5f0-1d24cdb6fc51", "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\": 2514\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54df2868-7705-4ca6-b240-7f5f251c4689", "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": "054da608-be7d-4695-a0f5-39572421023c", "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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "663bd752-9e4e-4e7c-a0b2-c52558c50c48", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f666fdf-8094-4d42-ba94-f766663a969a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daefc3d6-6590-4141-b9e3-85a6be05e7fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adca9c0b-9af2-48d8-867c-e32fac10059b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ee3395a-6b7e-4964-b181-f3d1022b930e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9958b8f6-7eaa-43d6-8a05-fc835dbd23e9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d325ac6-b25e-42d9-81ab-3c38899a27d6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f1552f-b349-4cef-bb1d-476e46daec16", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b730541b-6c99-49b5-8f5d-44fb93c1b1f1", "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": "8634a506-2855-45bc-b673-5b3a49f36866", "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": "f3ccdf90-7843-47de-b811-66eb281a7613", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "910014fc-066c-4f26-b5ac-9e5e82e0b5ff", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c0326bc-36df-4c50-a25a-04d0c56fd802", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "810a31c2-0105-41c3-a90e-dd1bce2f993f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa01916-bf39-4e42-82a8-74db45ac4623", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "598f30bc-5c4b-4394-8da1-8bb8204684fd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e0291d5-6cd1-4331-9d21-97a9a489ed9e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea8dbd8b-75a3-41b4-8295-8c81d81bd168", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afe24f2f-0101-476e-9f22-991bc3e93e15", "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": "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": "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b9ee99f-af28-4d02-b876-fe19668c8dee", "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\": 601,\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\": 9683,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e6c6dd8-5323-4929-99a6-ebdf0c1a3b68", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4659bc-6855-498f-a76d-02026c33c9ff", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1bfa8f-80cc-42fc-b9ad-312e0e269802", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb472f35-fddc-44b0-a929-d1b5a41bbed8", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01119c70-5e84-425c-a2a4-52f4b7ad84b6", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40a666ce-5d41-471a-a690-77d91588d980", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd05339f-44a5-43b2-ada6-3f78869a1c63", "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\": 601,\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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecad3228-a8fd-4ffb-98b5-a8670f10b95c", "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\": 601,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21e3f48e-160f-430c-9e02-c9ef30c4e89e", "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": "7950f18f-8791-4641-934b-1f3abe0fe3bb", "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": "ee2a9a05-4026-415a-a5cc-c0fc68baa7dc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6931b578-a295-4f0b-a5a6-e23976235e25", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a06a9b00-a800-4bfc-8b1e-74abbcfe5971", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf650d93-9dd0-42fb-aee1-2efdada6c4e6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ac610c-40a4-4c9e-aef1-739e7e2320a5", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f03b2efb-021a-430c-8f1f-d6804982b353", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06abfd4d-32ac-42b4-81a3-d7a486bda632", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3631fc8b-fbaa-463c-a3c3-102675b715ad", "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\": 4327,\n \"message\": \"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": "74533284-542d-42f8-80a8-e5f0502850a6", "name": "User Groups", "description": { "content": "User Groups endpoints.", "type": "text/plain" }, "item": [ { "id": "0454d2f5-c346-40f5-9cd9-d08f1a25447e", "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": "949beae7-3a8b-4ece-a895-5f4d0a1b803b", "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": "3bf51866-21ed-42b1-8b9b-98dcf5af293d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58eb30e6-6083-4d49-8298-8408829ab6c2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "070ca109-4736-4485-ba8c-f82dd1ebb755", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc362c21-cec6-46a3-bcf9-e04528340fae", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e262c3-60bc-44ab-8c53-8a8ab6e57e73", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee6b8057-b982-4ad3-90a3-4d95548479d2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "372958b9-f1a9-470c-84da-4418f8876f68", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d32a8ea-1d4d-4071-b7af-34e8e3a6d27c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcbabdd6-58a1-4752-96f9-4ff0c2c64171", "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": "4b17102a-05b9-42e3-8cfc-15353cd1147b", "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": "badd0b5d-3b3c-4c49-8a3d-5c8b13666831", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b21227d7-7b14-4157-8a7c-5453d206f8c0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed46428-ad40-41a6-a8b0-14706d947ae3", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5218b733-8df2-4077-80b2-193208b2326b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cef7c106-dc7b-4684-a354-5e0807fdf7d1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0afaed62-090f-4869-9d10-fbb9fd474ac8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adabd69d-62a4-438a-8b65-9fc4430f00b6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "381b34be-3d52-4b5d-b730-2fe95705e769", "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\": 4327,\n \"message\": \"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": "dd3e621e-3200-445f-a8d8-e14f7a8f8a25", "name": "Users", "description": { "content": "Users endpoints.", "type": "text/plain" }, "item": [ { "id": "9c6a41ae-6b24-4f0b-a034-05c7592e901c", "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": "bcbe8c42-7ab5-49eb-a677-6e103df8f7b3", "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": "24fe042e-9111-4fb9-b041-20c4103368f0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17de387a-458c-4c60-a452-58aeb37a7192", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26dcfc1c-33e5-48c1-911d-1bd1a5cdbe7d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef5bcce-3081-4007-867a-d5ce464425cd", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dee5589-e976-42b6-906c-fadf12a155ec", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87df3684-9423-44d1-83af-1b44f97b3528", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "260b0f26-3c44-494b-9b90-fad640615668", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6751682-1d1c-440d-81dd-26ebdf47309c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cab3aebe-283f-461c-a405-7e092ea9d23d", "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": "address", "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": "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." } ], "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": "88600701-4d5c-49f3-b8a3-9cc17ab77f35", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"partner\": false,\n \"admin\": true,\n \"status\": \"ACTIVE\",\n \"id\": \"string\",\n \"global_user_id\": \"usr_abc123\",\n \"keap_id\": \"string\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"middle_name\": \"Edward\",\n \"nickname\": \"Tony\",\n \"spouse_name\": \"Mia\",\n \"suffix\": \"Jr.\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company_name\": \"Acme Corp\",\n \"created_by\": 1,\n \"create_time\": \"2024-05-21T14:30:00Z\",\n \"updated_by\": 1,\n \"update_time\": \"2024-05-21T15:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "960a787e-f176-46f5-869e-76a8f8634a34", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0684ceec-8fd0-4d49-b46f-9e2d6228b395", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e4d8eb9-805a-48da-b991-f00f5f65ba37", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6e7a109-b61b-4163-a79d-ca3656b65c9e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "938b9a08-aaae-49c3-8ef3-1ffcbdaa1897", "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": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bc4a8ee-ada4-429e-8b6a-a1fdde189359", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "email_address" }, { "key": "update_mask", "value": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93c140f-5810-4e7f-a37c-ba9507510062", "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": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa84f37e-5ce8-4428-a3d7-4404c93735b5", "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": "time_zone" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fbb4363-31f3-411b-b18a-9b2954e3d891", "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": "d717773d-4016-41af-979c-557c3eb1e9e4", "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": "ac8c3c03-d05b-464a-b302-5f57eea8ed5f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e25319-b241-4f2c-9d4c-bafa09a57105", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c51f7b-93ae-45c5-a720-b3b74ea072a1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c74b00a-7aa2-41e4-8a30-e3514f5f9870", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03695171-9a9b-496d-98f1-0d9cc439fff1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38745bdc-b07c-48fd-a80f-710edbb2065f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72cb45dc-3f4a-4626-bd03-81258ed91606", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12857314-4cbe-4bca-abfa-1edcc7f808a6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff734c27-872e-48f1-9b3b-f41852bceeb6", "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": "83b16085-4a8a-49b1-bf57-3809f09da018", "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": "1cea249a-bcfb-4bac-9a0c-aa3c0ca5a964", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d517955f-210b-49bd-9641-7ddbfb86a1c9", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4596115f-d1ea-43f6-9a39-f60665cf9c58", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41ad84cf-f6b7-4b23-939e-3029d7ded075", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610c5d3c-e9a3-4126-9c8d-9b03bfe8f734", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d74eca6-b80e-46ef-a578-73d4523dc412", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33ee7928-7a2d-4727-a63c-d5be2ee6569d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a077908-d9ab-4acd-857b-7037dcd4bd0a", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3fc3cfe-e24c-4c61-90ad-023ffd00d604", "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": "2acdb128-8054-41c2-aea8-d1b381676157", "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": "94589b01-8743-48d5-aed2-97021fb9f4a7", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d4316aa-ea1e-47b2-9b55-6c3aa9540a1f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c323231-b23d-4f3f-b9f4-4e1dd982ab9b", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8a6721-afbe-43ea-9b8f-74377f576e9d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f09e6598-4354-4d0c-aabf-75a1b2c94af0", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aba2094-e3a3-43bf-b5b0-7b38579d451e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec98c685-0b54-40eb-aee6-4ad5bdf2ca89", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "740cd040-0362-4a14-94d7-4760b64eafe1", "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\": 4327,\n \"message\": \"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": "8bdacded-94fe-4f8b-b615-f92aa43dbabd", "name": "Webforms", "description": { "content": "Webforms endpoints.", "type": "text/plain" }, "item": [ { "id": "13483c6b-c6dd-40e5-9a75-1907b2edf53b", "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": "296f426b-6fb7-44a9-b7d4-1a4a410a7598", "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": "8e82e5bb-ad9d-4249-9c8d-cf310220214d", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1668b7-9a57-49a6-8794-8171d298d45f", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "293e6ac2-9c65-4f4e-9b69-5a01dfd05ac2", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb077489-d96b-4aaf-8414-5f3c6e64fe70", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7edcded-8b1e-4f3b-a525-ae3e22f7a321", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f4aca3f-72cc-44a9-a043-ad9ded04cb27", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72efe992-1ccc-4718-b4c8-babaa47333c8", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "057b0bf8-bd1e-4b51-87d1-1a8df57166c1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3e6bfc0-838d-4a30-b145-c35bcf93f7e2", "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": "fc32e6d6-401b-4ea5-9a44-811c87a7b4c1", "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": "8fc6f967-f551-41e4-8f4c-af7d5d43379e", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf83e46f-18b0-4151-a5a6-3f7b0ef0a484", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "214c56ad-2faf-4af7-9829-8e605b5c67cc", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ca7c2b9-24b8-4d22-abfd-efeba30099e1", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf27324-3bcc-4c52-bfc6-3607b1424594", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6e858b-ef1a-428e-8b8d-cc1f2cf6012c", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e70e76f-ef6d-4692-9fe2-1e0e12133aa6", "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\": 4327,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d01e56-d115-4761-88e6-ead94be30b4c", "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\": 4327,\n \"message\": \"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-intg.infusiontest.com/crm", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "webform_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "subscription_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the report (Saved Search) to execute", "type": "text/plain" }, "type": "any", "value": "string", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) product_id", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "category_id" }, { "disabled": false, "description": { "content": "(Required) ID of the payment method to be deactivated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "payment_method_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_item_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "option_key" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "file_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "sequence_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "commission_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "affiliate_id" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "https://api-intg.infusiontest.com/token" }, { "key": "authUrl", "value": "https://accounts-intg.infusiontest.com/app/oauth/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "07b5f246-3526-403d-aff1-7d37c100a444", "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" } } }