{ "item": [ { "id": "7d9bacab-cea8-4ba6-8b6c-a8e915408e83", "name": "Affiliate", "description": { "content": "Affiliate endpoints.", "type": "text/plain" }, "item": [ { "id": "35c3c6fa-4d7e-49a5-a311-3ed860feeb9b", "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": "28fb8477-7614-4f85-889a-42459dc387e7", "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": "50fe3d84-b68d-41c8-8af2-16aa528276da", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "312edb43-0015-4e98-a7eb-654d53e8ce61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1be0d3-b70f-4023-914b-b7075890f119", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2042ee19-a3a6-4385-83c6-1ed8b968049b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e36d6fdc-d4ec-4bef-93bb-16b2f988217c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9db788a-54c5-4c3c-90b8-0007be1ae5dd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f28a7bb9-2637-475c-b1be-1e31a2af77ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14637440-c908-4443-9aa0-489644226c5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5748587-07f7-4987-b6b9-bbf80d83bb0e", "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": "103a0d99-f778-4801-ba6e-cf256285ff52", "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": "b6061b47-8a0a-452e-965b-ad5d6779d330", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618cfa22-e0c5-49ad-a5b4-4056fbbd3041", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77aa1b9a-d454-4962-beae-28d53691122e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2904cfc2-62bf-42d0-a455-4278547b6a27", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c74fca58-e1a8-4405-8e5f-bd8e4e0a03df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72dd788b-abe9-45fe-a229-c2c779ff9f06", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fa8616c-f477-488a-a7f1-ef0e5fcef22a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d881a14b-137f-4dbf-aa3e-024d1f35f886", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5dcba8e-3054-4a02-ae80-4a5b49191760", "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": "366a01a4-9d83-40e1-86a1-3fc561bf70b4", "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": "84416d5d-d5d3-4786-83de-37a86b4dead7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ea4d15-2a67-4972-93aa-ceb92a8b8378", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3afcab-8274-42f0-a3b1-16390635e543", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "444f2178-68c7-47e9-bf0c-799baf5b4845", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2118623-5bd7-4f75-8630-c680230f69db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d349aea-4abb-485f-acd6-a87ffa0875b5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec37a0b-c6ac-4853-97bf-f8e288c0bd9b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900b53f7-c06c-4357-97d1-bcffa4b12acf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1840a0bf-f552-4757-8a78-a4f50a1b3e0a", "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": "5ce7474f-2db1-4fa4-9a90-aa988d364145", "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": "804c2f3e-1203-4f84-b910-6481710dcb79", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48058b59-b169-4bcd-b0be-c87235360e4b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1396606-3c17-413d-80ec-4ccda5e8bc6f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5ffe03b-43e8-4cd3-841f-0b4493d2c054", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2afc4a9-b826-4b04-9d03-b7d348f89199", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d9441c1-84f4-433c-beb6-9370f5ff684f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9a21f9-7fbe-4283-b442-fd021c17a450", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e812686f-41ea-4104-959d-08d383f494a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41555b3e-7f51-48a5-b574-ac320caad16c", "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": "f245c9c3-4c0b-421a-a2e3-8ef6ef38af7e", "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": "452d1e17-f7fb-433c-ae56-5b96cf5c1851", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6ce877-36f1-43da-b3c7-21eb47d297cc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0e80f97-2f96-4fe2-9be7-fb7e5f232ddf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25c6f12-2691-4f3e-9aa6-09e7922136a1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "107b7d0f-17d8-4314-9c4d-a20cb5150ce4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d55e0092-accd-449a-97e2-f01bc67d45d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df75af81-e079-41dc-a266-7a8e97c18bd0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cb6982f-928e-4076-a2b1-a58d22162ec6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56ba4b6a-faf7-4b78-88e6-b629a486ae0c", "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": "204aaf94-4b4f-4b65-9b99-ab5fdcb5b162", "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": "840b9287-9291-40a6-be32-d280801b5b83", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f26eef0-7d1e-47b6-a48a-8c2463fba149", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ce2a62-dbe3-4374-acda-5bd89a46e9ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f028589c-1800-43f4-aaf3-6e641a8239c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc1b0d8a-9705-4ce8-bdbc-a2d280ee4797", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "834215db-5965-4433-9012-24197bc7d3a4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae8af8e2-cfcf-435b-89f2-08f5cb53a173", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0035c3b-83a7-40af-a3e0-79f9116256e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b588b0ee-324e-4a38-b836-4ac322101990", "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\": \"PERCENT\",\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": "4c9c3457-25c2-48fa-8de2-415c761b0173", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc6725ff-a8c4-4b0d-9b84-1b21a6c43390", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03fc60ba-5341-4f68-a806-b7e340073551", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7159bf3c-4ebb-401d-97ef-47c512416f52", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f18a3c00-0ecc-451d-9f8b-67a10a57d1f4", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4ae6b56-4e81-4feb-afd6-27640c040071", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67fe25bd-779c-4a75-bd5b-93766121c1a4", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8063fbe1-7a47-4bb0-b7f2-e8c4fa8f45ec", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d062eef-f9e6-4a93-85e6-d59a302bc518", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "804cec78-2001-43c7-87c0-45381c5ec83d", "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": "736e0e02-b1f1-4786-9b64-a3bf937876b3", "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": "276a8c92-218d-4dcd-a99f-e55051274340", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db7440dd-9f4b-4cea-8f3b-32e7b02a003a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f95fead0-602a-4caa-a5ee-6b8f41280ef2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121cc682-db1c-42f6-afaf-c51a34768175", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "842c0273-2387-419f-a7e2-4bce7d543fe1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f8cc411-c804-4ff2-809d-b80ade1ecbca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc01d2c5-e1de-4b14-9c01-221e277d568d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda56c2d-9430-496a-87b8-a9f5d7a53649", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1642b5f-f6c4-44c9-ab3a-d5ed20b27998", "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": "0c3ff2bf-819e-47f5-bfab-962313d7e081", "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": "1dd893a4-ab12-4a52-aa96-c4ff7014a314", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94cb63d0-7710-4083-9770-fdef182314eb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a91693f-9782-419d-abca-3fe0fa7fea1e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98453ae4-addb-4696-b1e4-f34a771d40ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ca7ee2-ca67-48bc-a561-b3707af32d0e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c8e20e-404a-4215-a517-66bde81b9331", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e99ab99-ea11-4bd4-9865-da7a2c782e87", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "644ffb5c-b587-47ff-9933-7e279b8993a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d86383b2-a160-43a6-ad7b-93d40fcf44c2", "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": "7c5ba5b1-e3e1-43a3-a153-cc4352d72163", "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": "3a14d1bd-6e02-422a-aa5c-1cecdf079c82", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67816a09-7530-42c8-946a-b6142046f79a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e8eb81c-3f46-4fe6-9f21-16fe4c4f16a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "962ca773-ee62-463a-9661-bd63710bea0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210e4a55-9545-42dd-9918-e4f2a666daed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7856648a-f783-4850-8a28-46ebf75f82d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a50428ee-8251-4fc1-8d3d-86a823868a93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53c1aafd-46bc-47dc-b801-8f8de7ee01c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9dbcaf0-3a2d-4cce-93cd-a5f74881d920", "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": "f63d5fa5-3e12-4b2f-b8ab-8000adae305b", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5bfa1f-3299-416d-8056-124972431b8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b27ee08-3a4c-49a8-8721-4c31c799808c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47049ff-c965-4dcb-92aa-a4ab513fd582", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61449dbd-0cd6-4e0f-a153-08259c92a9a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16acf994-83ca-46b2-a4ab-fa7e09ac245d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ca65dc-9004-49ee-b150-f30ea5214a27", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1535f51a-f25a-45e6-a415-df6531fcf6c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb8696cc-ce5f-49e7-87f6-665d162af96b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02b8faf5-d79a-4f96-a2bb-d9e412e36cf6", "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": "fa196e8a-697d-4a43-97ab-a6bf94ed5544", "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": "c7a31b36-aca3-48dd-aa34-5473ea1cbb40", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae773ecd-fa17-486d-bfbd-e62bbcfe4157", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da660bc-7046-4d1b-819b-c03d2acfd91e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf86203e-3dff-444c-a46a-b821056169b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e78fbd-9573-4b3d-a494-ecefb6b29dd5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e79ff687-7b05-453a-b317-0f7ab0eb2518", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f52f27d-2d73-41c2-a56c-6b92f6bf0f2d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f3903e-0dc0-4b3f-9c05-339598a2d325", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fdd21dd-c389-42fd-b86a-84d0a5afe1bb", "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": "36e98c28-6da7-41ee-a6b0-1906465e8c14", "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": "f0f3a570-133d-4d60-8e85-93d906a86716", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05a7420-22d1-4ccc-a7f9-f71d222bd4d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5cf0638-3811-4a63-abac-86b9e5bcae24", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff2ae4ec-07d7-4f58-8981-fc37a571a0fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324a5379-dbae-470f-8b69-cdd6f6de48cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c31661d0-1bc8-4950-8158-a90899cac88b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50102d1e-268a-4e2f-a18d-040d626381b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76028f2c-7ded-4d1d-ad93-29c4bad0b914", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d5cd29d-c5bf-4fe4-853b-fda1946052a7", "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": "25ccaf01-6529-49c8-abcd-82d07dd9fe3b", "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": "5085eee1-a940-40fa-89c2-78a9909ca8aa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dc60c00-2471-4258-9bdf-880437896f46", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f7da898-9862-4b62-835a-239edcaa6c28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "361f6c22-1627-4fa5-a24e-900bb25599f3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138d534c-3e5d-4157-8718-9be469c01144", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b208f8d-1470-44f0-925d-d818a874087e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526e69d9-3398-4b82-b275-61403e37111a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce7be2f-db19-4bc5-89d6-8a5b44e5b17f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea240324-8c18-485b-8b80-323e690616aa", "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": "19280da2-4762-4097-a1dc-32a30b4d5481", "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": "286a3c0d-f294-4826-a174-89680e479007", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb50c085-82a4-4226-8fba-cb8a923026f4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "513a08dd-1104-41f6-8170-5a3ecd08ef75", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cdd1e6b-f9b2-498b-a91f-b2a75df329af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f7e8d6-809f-4242-9d5b-fcba4c9f1a23", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fa45676-83f2-45a9-ac7d-a6406a9d3dcb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f3c3da-0d53-4a6e-b42e-f63ae39c90f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de40204b-836c-43db-a2ee-7079833596fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e5f3fa1-0165-446e-a8c8-dbb440bcf84d", "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": "1391f1c3-e469-494d-b0b1-1cdfa03578aa", "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": "cb297175-36f2-4f4b-8393-1d9a42d2c5d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14fcd177-dfbf-434a-872e-1eb870ce3cfe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a171ce66-1649-4b7b-acda-0d3c2407d367", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e130c80-b08d-4dd8-8398-427a1d7cb5b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9743cb0-dd13-4a3c-97f0-190dc4dbbbf2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d0f30f8-c85e-4363-a68d-82a21bf391a3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f47d0d9-eef7-4614-bde2-625e2b2f139f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b7b9a1b-2afa-45a1-8df8-12fda8a2cd28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46beacae-8742-49e3-ae9c-08124c8d4fe7", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "level_1", "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": "7692a96a-b943-49da-a4dc-5ff3b96f40d4", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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": "e134b527-7e43-4bdd-a701-004b95196757", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0027cf-c186-43a5-91d7-c85e83ab44e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa85023a-acf7-4c00-94ce-8236fc0b16cc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a2a87df-e5d9-4bd5-8573-ca34b01b8d28", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ec45d2d-b273-4b99-8896-3cddaad10d77", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81a10f77-320e-4f44-9f27-e9ec3a8fbe1d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa34adb0-6249-49c4-b5d2-10004e4e8c73", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a344d86-98cd-464d-bfa8-3545805e2120", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "subscriptionCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b69416da-274a-4967-8a92-2222255625a3", "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": "605ed02d-4c45-4434-9986-b3354eec898f", "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": "bd3a8dae-ca28-4d13-a3c3-cef44ba37f43", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f95a2731-832e-4f28-9b63-445de2561c30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d2d4fc7-37c0-4e3b-b83e-dd01577bdb4f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7b0a1d1-f105-4e49-992c-357ff9fd0bb8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2efeb5-fa68-4b4a-a7b0-591ef5648370", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e89f5546-e687-47ca-9a47-cf5d8cbf6818", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9be2476f-6c3f-4564-8945-b15eb271667c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7231784f-0790-4f1c-aed3-1af8f31a4ca4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ef79f95-cb66-40e9-b837-865b1c0bda67", "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": "1e7ca3f6-4070-41e8-acc0-e25cc81d8cff", "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": "c4d11533-c5e7-4fa7-b6b3-4fa3527a86e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cbd3153-5668-4d20-85a0-eecc937afbbd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900844f7-9874-4a38-8fee-96c6f7bae262", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b835ab49-8c54-47c6-b58d-3147189d498f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "983ccfa2-f98a-44a3-84ae-31fdd25adc84", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5946814b-5e49-499e-8f92-c3a7cd5dd4ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd42dfe9-f7e3-4b12-9d18-51b73b706c96", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33800805-9cd7-4e51-99f2-0daa55811243", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e73d580-cf55-47dc-ade0-784e03c557e1", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "level_1", "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": "2458b9ec-edec-4fde-b750-ecf87b5f09c9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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": "d3f103c6-b4a1-4d91-9579-04333a105728", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05c31e62-8462-422a-b163-c35afd4e1a22", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90d1ad89-1e37-4fa0-b598-8145e0667b8f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64f64371-e4f1-4778-8956-cdf6067dbb31", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e5e5baf-9ca2-4c94-ab4a-5c3952485162", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b70015b-295d-4a28-9f2c-1f8d3b13a025", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d33721-c263-430d-b1d9-df867ba384b3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ed46002-1760-44d5-a2e8-ff8d8f9d3d7b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "productCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7d49f38-6134-4b09-b307-4a51b4970df3", "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": "64495a88-4abb-4236-b15f-c6b548fd3e31", "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": "b6558bad-ceaf-4bfb-a01c-1e4eb25a4a6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b1e4ca7-e1c1-41fb-a5ed-f0b1264e8fa3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8fa58f3-7e58-49b2-98d3-81c170d4be9e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f15dc3b4-5e0f-416d-a768-9c55a6036960", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e27e66-8e67-43fa-90c1-cac6a96afc4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6935fedd-4572-4ef8-a204-7e4052241510", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd41abf-5fca-463b-ba9c-11dbd52bc850", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0536fe-c2a0-4c08-9028-e579490e3e36", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83b346b8-7db7-486d-ac18-ccb2b2cd8e91", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "level_1", "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": "a0783f2e-5070-4cbf-b962-7127222a0983", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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": "84fedf21-6fda-4658-ac2c-07cd96053f78", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1820da34-0bf5-4f35-8c56-bee1accef17f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac5d6ed4-92af-4455-a731-a84ee83e3f30", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a280de5-9e3f-43d8-8495-8b74c773d69e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080c128a-a4c3-4bff-89db-5e25b72657f4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d23d1ec2-7eba-4c2c-b4ed-5ba2d066cf79", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c313883e-54f2-4854-9a2d-a681fefcf90d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05128a4c-87fd-416f-9728-6ef92c919731", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "defaultCommissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "unused" }, { "key": "update_mask", "value": "dollar_amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5eaaf572-eaba-4bc7-b742-15fd4b0024a2", "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": "ed91edaf-d329-4374-a808-4d80fc636b59", "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": "9a737fd5-9d1c-473c-a4ef-0a33fbeb2d1b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb68cb0-2499-4f3a-92c1-e939e550098f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41473eaa-23d9-480e-ae95-e42aa6d460b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a73c86-11ca-4823-a890-7e9ff08ba9e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eece03c9-512c-40c4-be4d-79685af9951b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaa02868-3649-4f53-8260-3c899d1b6656", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e58c8152-a2a1-4dbb-818d-7384f41f68f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b196350-8705-4f84-b8d9-ef34b2311741", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89d212de-caf7-4461-b345-71b47687b099", "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": "931f6fdc-92ba-4fd4-83a4-3f88db5824c8", "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": "93d4169e-62c1-4cd6-a849-bc359b3e5289", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d7b881-0396-4630-a941-8d388553d019", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af53421-24e2-4f62-bae2-f4e6b0e4eca6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e4944f9-8823-445a-8276-87ba66d4d049", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db844862-1a69-4853-9be5-3e134f4d58e3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f1771a-2ac8-45d0-a843-61f88b35c019", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5983da51-8086-4296-b9b2-0db869765453", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "137f2583-85d8-4838-8c2b-6b8aeff9d070", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb71fe95-a9e3-404d-be57-6f1b9ca08269", "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": "notify_on_sale", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "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": "db825d53-c231-4e69-95c1-4d9ef1dcff3b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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": "ff94fe82-2e33-49b0-917c-84ace65cd1bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f73167-3fe6-4c7c-857f-71cbdb83ba31", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "604a2b76-e441-4c74-b0df-3891d0b8f9c5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155ce7b6-f0a9-4728-a71f-3e781932b6e0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641c1d00-d8e9-4fd5-8678-58a56202ba0d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5100ff2-5964-43ec-bde5-30b92a4d10ce", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2932a70-4430-4fa1-9ec7-d10d2bee4c19", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b01b5574-cd56-464a-b454-7a4854c69dac", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "notify_on_sale" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "804d4df2-11e5-440f-bd06-ca6b52dabe7f", "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": "d693594e-fffe-449d-ba21-5afaf701539e", "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": "f10b3f06-82ab-4b0b-991b-44001ccf396c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea120f90-e112-4cb4-a42c-f2400595b494", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "349d9f4b-78c0-44a8-aeb1-d3e90d1240b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cd71427-4781-4bcc-a16d-2eee083ba252", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "454b936b-3126-4d17-b741-dc36843c3607", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d73053e-d277-4eeb-9ed1-e24f9cb5a662", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387878da-c3e9-42a2-808f-08aed21610b1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246fe0d5-7bbd-4744-9264-cc566ebc75f2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "043c7a79-b5cf-455b-b3b2-18ada44c418c", "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": "d3282f52-6213-4722-b183-13670be3b446", "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": "83d0d66f-c054-483e-9d42-620cf3f35997", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7b902d2-e288-4fa0-af8e-8dfb796943bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f66941-a090-4c83-9122-06c3cf0f1bc4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "243e3001-6c47-4381-838e-4730aa6a87e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a744017f-a737-47e9-a3a9-359b0fb4f2a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "731a146b-6155-4bc3-866a-7046b12c5d75", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52ef2453-3721-4e28-94b8-35b98fcaa72c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f742a3a5-654d-4d20-9f4e-56eef371b20f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23880399-c161-4b05-be20-7d8e052e669b", "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": "7d497c9f-466e-459b-9421-efbcb5e843d8", "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": "2584eca4-58fe-4fa3-a6e2-7171c71eb8b5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49be4e62-df18-4596-9d31-084b0d5fd57f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5cbf3f-d667-4753-93b9-f83a8faf4b5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2170bd83-c9c7-4b64-848b-da02a14a42c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c74698-97cf-4c19-9f39-ad13ad6d72de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af0726f7-298d-4790-a35f-d3b4a754c210", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c73e12f-8fbd-48e0-a399-0fcb98bdca14", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9aac8a5-ad74-4c8a-bee1-14f43ec61569", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f9e54e3-b47d-4854-b7e7-fd58df6036d2", "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": "ca764192-a329-4cc0-8812-252afe35072d", "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": "100d20aa-a5d0-4b3c-b973-6ca0b4ba6df4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efc1964-7a85-4ba8-83ca-f6d0379e9be4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3113922f-fee5-43b3-8a9d-1bb712c08545", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb388729-2d49-42bc-a26f-4bbb77586921", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9fb9eb8-5509-4634-87c1-453dab0984f1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f92c8c7-ae17-4b46-99f2-be8b1d484d11", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b394db91-a46e-4c68-8b83-4428212eb786", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e48ed508-b434-4c9c-99fc-d82096efd50d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c390b99d-4256-4f7e-a605-644f94e37683", "name": "Update Affiliate Custom Field", "request": { "name": "Update Affiliate Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Affiliate object.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b8765ba7-6869-4651-b3b3-b08dd17db9df", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7694f2a8-4ad2-493d-b225-970a841fbe90", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53cc6ef2-09c9-43e2-81d5-053ebf0ce8e7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa2d1c33-a7ff-4b35-a926-882c275d7a20", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2bde371-b5ce-42a5-875d-50ffca497c81", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cca640ca-005e-471d-bb79-6be44fc02c1e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fde044b1-52a2-4492-a94f-ba10e4de8ed0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a613fe5-bb31-4780-b1ee-090c4133dda8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943dad6d-e0c1-47be-997c-0044ebfb7ddd", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "accf4aa9-86a2-4798-9a39-d07de515feaa", "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": "ff5a4fbb-86ca-4121-a36b-f041dba3a7cb", "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": "67d7664c-73ae-4a1a-9193-7f28c20eb2ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c18c8ab-4d2c-4f34-b712-048b4b2a9f54", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef078a16-8958-435d-b519-4612b6bae780", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b69a9f3-6941-413e-9d52-b1ef1929f762", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f6df4c8-2666-4b39-b00d-1105cb92ae9c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9859175d-359b-4754-820a-97ca3229d9ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9da4f74d-3e8e-4fad-ba82-161fd39540f2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f1a7fb-7d64-4173-ae4c-ba4935979952", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bb16845-d957-472a-905e-7d9d98c30963", "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": "18f5d04e-3d29-4a36-b0f9-6c0f8aa9e8ef", "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": "1dd67c19-52a7-4bc7-acb2-1e59f932e87b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "792613c6-6f54-428b-aa62-f156c46b49ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b262e1-8db2-4259-8a14-28bbf6ae87b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ec35b8-a326-4f7c-87c0-6c2654f854f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3871ce4a-8900-4e6a-9ea3-796fdae22528", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c631fa1-412d-487d-b02b-8a2d910f3904", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2b9971b-188a-476c-900c-c3902ed1d26d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1630c9b-0c30-4a86-afea-5de32e323f43", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d88208f-9254-424a-8841-bb78421e9545", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cfa34b4c-a234-4267-8f5c-3caa15d229d2", "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\": 2647\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": "8bfc90ae-2747-4a53-b800-b19285daeeff", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25eee162-637d-47d0-8829-080b2b52391b", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1265f53b-be5b-4cc2-9134-f349598017c7", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbf2b3e0-2384-4886-97ad-8e7cdfa095fc", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdbfc936-c149-4848-9498-9ca3c64179b2", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afc327ba-83be-454c-9388-c5014d6bc297", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b632ac-4644-4187-b3b2-35e587eef892", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313ee278-ad90-4aac-b0eb-75bf2f541dc4", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e610c39b-2ed7-43ef-9857-7d490815c795", "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": "94b4759b-00fe-418e-ba11-9553efb3178c", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2f77d0-1ad0-4ada-8018-e7ff63374f29", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cfdce9-bb02-4120-97ff-fd987014cf20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8673222b-df36-4b58-a50d-8f827e7fc645", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df0e93ae-63be-49a9-9ce5-950006fd192f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dc7e31b-fa33-4880-8a91-a9f1eb7d578a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab4adfb-1297-401a-8aa3-523fac92a627", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "672f9795-fc33-4435-aa51-ab5e982df0a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a49238c-7e02-4a61-a075-915a7920b937", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "839b235a-7026-4b7c-a798-487aac363084", "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": "3baf6d59-d718-41f7-b37a-951f58a14062", "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": "c4e50b7a-6db2-4898-b73b-098121219c40", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83642d8c-144d-471c-95b0-b7f99dcc8ea0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce52b043-b672-4f49-b282-49f28ea7267f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9d7c45-3b74-4b85-815a-318f7d3de000", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "041d772a-96eb-44f2-9d91-2483367f0eee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06fa5f49-e2bf-46b6-9f6a-0cc26b7c8ade", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "884293e2-7ffd-4007-8324-5562a39152bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d7d2a3e-85f1-4877-8c4b-e13837cd80df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa0edd11-b1c7-43ec-830e-e04b5f2eec8e", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aae06843-99dd-4531-bec6-8eecaa6f348b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c35b0c12-bbca-4839-8098-d705411ad45c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f72c0132-810a-4182-85fc-2746b72c65c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae1a4306-9778-404a-aa8e-25aa6ad35e1e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05c791a-b42c-4f0e-9ad3-64687208053d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a998539-1489-4476-86e0-0354dd14060a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c202763e-6f19-4b25-91df-ba9575b30e8c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c078240-cc14-429e-8a8b-23b341237cf2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b41d790-e295-4b50-b368-40ff141edee7", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe38c72c-1c07-4afb-8267-7d81cdd89725", "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": "7c4a6971-f283-407e-82e5-76b2bb524378", "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": "4ebeb1b3-5bca-401e-bb2b-d3850075c824", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e89579ef-e631-4fc3-98d8-d4644bd2562f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf3417e-e496-4f4b-81b5-be99abe31131", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beb13afd-c0de-47f2-9052-f8354e8e7677", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "301a29ed-2683-462e-bba1-025864d5650e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d59da789-6c0d-4bef-a02f-d3601cf46639", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6baac21-0053-4f12-9517-92510c9278da", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47f09a16-6c66-4b3d-ae57-0e9c9aa5dc33", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71dc492a-e074-4448-960d-326ae6d39cfb", "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": "b295b8da-17ab-48d5-a7dc-1cbaa61d503b", "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": "635e4a74-76f1-40c1-a582-84132eb95e7d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c1d98e1-539c-42e9-bbef-8f02522d9d3f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "817f6bf3-a285-4d26-bd0b-01a6e3328655", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db3b919-f6b2-4909-82c2-75e28c03ea7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7f5318-3c44-4cd4-84eb-34f59e52a82e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb873eec-3d20-4253-a0ba-266a98e9f542", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f55ea6e-b68d-4f65-b3be-7ae2e349b585", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a47346-cc5c-4cda-a212-41887c6e752a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50f1c6af-4f64-49b0-b573-7e92f8d5dba5", "name": "Update an Affiliate Commission Program", "request": { "name": "Update an Affiliate Commission Program", "description": { "content": "Updates the properties of an Affiliate Commission Program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "priority", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "notes", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commission_program_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Fitness program\",\n \"notes\": \"20% default commission\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bff11e26-3fea-4ffa-882e-1193eb52650e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "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": "33f7ca42-d693-46f0-8bc1-04b2158bbfe5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ff7dd1f-466a-433c-9b04-17255c639833", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3252320-0b3d-48f8-b491-c353b38e17a6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3142dcaf-e268-4db1-a867-e292e436a06b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c6f2f3-1fe5-4a76-aedd-ac1bcac5b8c7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "721c1f6b-1b20-4042-b452-6c2e50877f21", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1b8a28b-4204-4159-9e15-c434a1764516", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0485b756-4a90-4876-a218-d74303b26022", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", ":commission_program_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "priority" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d3b102d-77cf-42ab-93f7-fa942604f343", "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": "2968f4e9-7d2d-4b19-b1f0-a6fdc2a710e6", "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": "4d90e4f6-ab2a-4506-b6cd-66cd0908014d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8448ed81-0af4-49b6-b95d-2aa316a07159", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b9673b-0a77-4812-a292-bb96eb507508", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af6a6c40-5022-44ad-bdff-f195e16572ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b28ce5-44e8-47d5-971f-8bbcd41b2b95", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c9b15b-7d18-499d-b746-d5ca4080bbf1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f6e469-b742-4be3-b6d5-c44aec199c06", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "950534d4-999a-42ef-a9a4-2c66ead21129", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f4e52d7-ece8-4ae4-a03d-465f9d298167", "name": "Update Commission Program Resource", "request": { "name": "Update Commission Program Resource", "description": { "content": "Updates a resource for a commission program", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "url", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "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": "9fa8d6ef-dcbe-4ab1-a0d9-b4dc8b433e20", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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": "f018d955-3936-481f-afcf-0503b1d2e97a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b02c0165-cf3a-45df-a7e1-079e3407122a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "254b0ac8-0364-4e55-9352-079c159ab46f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0028fe9e-2088-474a-bb43-0fc86bec35bc", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24de6934-19b0-4a69-8385-bdfeddbb2af7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3180c0da-5bad-4429-9359-fad68ffb8af1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e566aeea-9bf5-4391-bca3-da0fe1a09bc1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7bd36ca-577f-41bf-8b2a-a7d499b9a235", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "affiliates", "commissionPrograms", "resources", ":resource_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c83f3fe5-c788-4b32-be10-01a0f74926f6", "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": "fa609935-0f2c-4a34-b5a8-3380390990f5", "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": "02173db5-ede7-40f9-8cd2-d5af7cfb1db0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ff485f7-38cb-4ba4-b23e-eb9dc90abb72", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a29ff01c-890b-4a79-b5cb-8f95198a9804", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a13d825-01c9-4ec3-bf19-7e8d7a798099", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d45c9020-d056-44ac-af6c-6b96608cb61f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255a6ff7-f748-42b9-be36-79171ed5efbc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d856b2a-4adf-47e4-9acf-9e3e711a799b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "492b8755-4109-46a5-9019-ff3a395a6134", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b86ee855-b673-44e2-a33a-236aad7c3455", "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": "46a7debd-2fee-4ce4-9dbc-560020015c72", "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": "791b1cd8-2765-4efb-b40e-3d804ec7f1d7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66cfefb5-0888-4adb-9be5-3148ea9671a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314e6430-1dc9-46bc-b6aa-99c3961bf283", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79a6e6c-5c6b-4c6b-8059-6478f10d6c8d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "211ffe38-59e2-41e8-bd17-9082e42fd6ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6086c68-f686-45ca-a7b2-f0e08330ebf0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cce9761-daec-48c1-b946-50ff6c7f04af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd12246-9586-4e1f-9d05-8f373053c6af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71e532ca-479d-4463-9fd4-1dfeb2bf1e88", "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": "16fed719-95fe-4307-be67-3ce7c8df3972", "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": "711f82a8-11df-47f5-8bc0-409f9d0fef83", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18101867-0128-459a-be54-1509c1d7a195", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc8521c9-e5b5-4600-aea7-e6010bfc74ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d4d5273-0391-4cf5-862c-2b1faace38d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32864231-6059-49e0-aeed-c27ecbc6e6cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "927fe66b-ca15-4d9a-a686-5fe591dc6e0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a124890-e805-45b0-b0c9-2c2374df8fdf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe615029-42e2-47bb-86cb-306f93947486", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7eca86c-a04f-4e91-8de2-56411c7dc7dd", "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": "8b6b0d1c-9aaf-4d60-8f60-b6ff9e938d3b", "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": "f0b2f411-c0f0-4eb0-8a1d-8ea6be82baea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "722413a0-78bd-4181-a74f-98f5fbfaed51", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3da22af-90c9-4dfe-8ce3-13c262cf5cf6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86035a7-1701-4b3d-8bae-53c73b55a7ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d41a8cc-09f7-4937-b92a-28e2d1d10332", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0da9b1e-81d8-4d96-ae1c-08e28b8643b4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c72ff95-3b4a-4c9a-82f1-199fa44ef9bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d7dd54c-1cc4-4d65-a657-a4dda8f0c5d7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea8fd4ce-55b4-45c6-83f8-1ea2ced22386", "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": "cc38f617-d752-40ea-b18f-140cc097c3e0", "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": "21ed0c6a-7a02-483b-ae07-77b03d595468", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d529019-3e47-4cc4-a502-f88cd12dd72c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "209d073b-7a1b-49ac-a079-c856b2ad543b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "712fbfe5-a8f0-4ac9-8b06-cba5f0b1ec29", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2aa468-e1ce-4ba4-baa2-32829eab6a02", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b841c264-720b-47cf-aba6-fda5aae28355", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c1aac4-62ca-4f90-ad33-393663837fe9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10099db3-f70b-48da-893d-b3a96d62e8ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32277bf0-8d2f-4a36-af11-a880d594b2f8", "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": "1025a17c-dcad-40bb-8f14-2667c00b95d5", "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": "2a9297bc-91cd-4a7e-aad7-f2f325826236", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "851dc6a4-e821-49d0-b2d4-2ccf3895006a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d5c4404-9b82-4e1a-bd41-ed7cd3835199", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5948bfc-67d5-49e3-a66a-e73811fdd718", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a31e2f3-b9ad-4361-b78e-55cc29b739b4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84bf9701-d6c8-40f9-8380-e89fc1c93bbd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21dd148f-762e-4f2a-9d40-3e8c5786a970", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f4ef6c-d450-429d-9cb0-91b5ca1c7584", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3229f2f-7554-414e-af66-84871f19fcf1", "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": "f5fd0066-145b-496e-827b-ab0e953dca32", "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": "fc1e4e52-d95d-4481-a39e-a4b1b4d5ef09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "857ccba2-1346-4bdd-935a-779400100d08", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5468d0e-b43a-4765-814e-89ae6b7bae96", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c773ef93-fcdd-4e1d-936c-5574b87f43ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28b49110-f810-460c-9f4e-a77abcc28f97", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57cfdc4c-7ce0-4567-bed7-98612386ef40", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a524c97b-3343-4c4e-b0f7-39174b73495a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49271258-103b-4e26-91d4-9f7a4aebcc42", "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\": 5119,\n \"message\": \"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": "cc6e4aaf-2e1a-448a-aa5f-cdb7753aebd1", "name": "Automation", "description": { "content": "Automation endpoints.", "type": "text/plain" }, "item": [ { "id": "b4b15cf4-4240-45ae-9e08-0a213f6d99a3", "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": "5b06af89-c433-481c-b1fd-1dc4d99ab7e7", "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": "a2fcb857-656e-4327-a739-25403a9debbe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c240937-38fb-4741-81e6-d57ac2a45b05", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee8685e-d103-4b29-bd69-c5097a560983", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b1406f4-d50e-4269-a2ad-29fdabbd8bbe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf0ebd01-b6f6-4991-bdc4-4eb5d0890a69", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9b9cc5-64b9-4989-b210-eb158799c047", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbe8cdda-5c87-4ad7-923c-e8e694ac4d1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd3c6297-943b-417a-a030-f21f3e26d448", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd45fea2-4888-4a53-9878-73ff07f40097", "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": "5e5e15c4-63c8-4a1e-83cf-862129c7233e", "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\": \"FAILED\",\n \"key_1\": \"FAILED\",\n \"key_2\": \"SUCCESS\",\n \"key_3\": \"CONTACT_DOES_NOT_EXIST\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08ecf729-4533-43d5-adf8-c44c35c05035", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb001234-886a-49e8-91b5-6e467684770a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fabe13d-567e-495a-a309-d181acc4dee8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde9460b-0abf-44ab-9207-d7bcf468f8cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09465d58-8283-46b9-90e9-745b51f0a132", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d154ca25-68d1-4acf-ab47-f75a7e7f6b70", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46d2b3ae-ac85-4250-a31d-f7fb6d022bbc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "362b22e7-baa2-41f7-86de-670a0af9fed9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d92867e-79a6-492c-962a-9fab1ab43feb", "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": "a656f892-52f7-4c95-b736-fb9a0823b270", "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": "68a5c7b8-e47b-4434-8013-8c6a46e02b56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf3456fa-6b02-45cc-b5ac-4c510e67a6a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5519dd36-b96e-4b0b-99f3-6855bf3508a7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b25ceaa-7124-4492-b57d-79a260778a07", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4598d3-e592-4336-ad70-868e4a1c1822", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54172a80-0f65-4d39-a87c-d69d467756c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b4a9210-1d1e-4148-89e2-90bc525d907f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d48d36f-a0d5-463d-938e-de65527e10e0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34dd3183-4bde-4d9b-bf6a-a44e604be28e", "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": "b9065ac3-176c-497a-ad3b-bbdf590e5b84", "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": "2c920ab8-57ad-4490-9be5-15a81a9fcfd1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa008540-34bc-454e-8390-bc68a3220917", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618aee4d-4037-4c59-af83-3108c751a6fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "030b1745-c897-4ac1-b2e9-6d1f013e4d06", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28a11f99-77bc-4fc6-bd05-3f6b78ec3394", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b2b7f68-a203-4b02-8454-0d37e55fc896", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac244507-ef7a-4407-998d-b6eec1e1a29e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f5fdd0-0215-45b5-9ac2-8743831bb53e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33ea1b86-70c4-4ca5-8f7d-8ebd2df4b9dd", "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": "bad85023-92e7-4c2d-bb5d-a325f979575e", "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": "55da2295-e1ad-4751-a601-63fc7c59df1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8750c8a6-cba8-4a20-9f07-b1b0bacd05e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e838b007-7b3f-4633-8b46-493558010072", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e0f6a5a-23c0-4c81-b0a3-8bc0f85478c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3016cdd5-2ff7-44f4-8277-fc6fe545c09e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89786ed6-41e7-4b2f-900a-3975f2b9d1cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da93bb99-ee11-4787-9242-c1d76b1fda6e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa3c13f7-f18e-42bc-a9be-8145aeacf87f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56c4f1c6-8e34-4412-8f86-c4cbcc977864", "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": "3e28496c-c82f-4d01-af77-f47b0d3e25b1", "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\": 5312\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7876de8-6f4e-4370-b34d-6abbfa9579ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b27c797c-80c7-4e13-a418-89b44dacdc9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49b6dba5-fdd2-40be-81ac-ed4d8a2e6df7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e40b7f5b-8dfe-42ab-9b48-544beae04927", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f989c5-5f20-4777-a5e2-8ee01afa82e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49ebe2a-31a9-4b8b-a10a-54367ea38707", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3d317a8-9a1c-4ff1-b7f9-e55004905363", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bafa99e2-165c-4855-93f7-631e995368ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fff3bd5-3d5d-465d-ab70-16c6a878125a", "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": "9141", "description": "(Required) " }, { "disabled": false, "key": "automation_ids", "value": "7811", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "89bca51e-8b81-41b0-a207-a307283af2de", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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": "125b2caa-8e91-4424-a336-ba3593454e58", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f224ab77-7f40-4286-b210-0b6844c29a01", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96c4464-acc7-40b4-be2b-e347e35a02bf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29c3e595-0382-4ded-a003-d2317a18b56a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc02ae1c-fed5-4765-9469-a10a38d212a0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acc79e5a-08f2-4d58-94a5-1b920ca48443", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d73f5b3f-7917-47b5-9502-b7268b5fe78d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ba2b2e1-7a91-4723-b978-b1faa7e92860", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "automation_ids", "value": "9150" }, { "key": "automation_ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6980a875-0f9f-48cf-8a56-f815d42cadcd", "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": "934476c3-cef1-4725-abcc-62515358d178", "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": "a59515d0-e2c9-4dd5-a3db-a94fdd27fc0e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e6a321-e68a-41f1-958f-c036a3ed1d54", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "216e4d58-99f1-4027-84c4-7f051526e306", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f921858-8e4c-4ff5-a939-ab4378fad916", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fd964eb-21f8-4355-8fd8-e7b046105ba2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fbf1643-5650-469f-a4ed-cbbe5ecff763", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "945bded9-7f86-4579-bf3d-c0197ec58b46", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0afa785f-d91b-416d-a191-5ca36778634a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "964a511a-ab99-478a-aab6-ffd7bccae92b", "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": "182f36d9-f738-4d77-a8ec-615957c109e2", "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": "a4da530d-e952-404b-b0bc-757510416020", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fdc26f5-c683-4c05-b6d3-ed9bc17e9af6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efab1bf5-587f-4fbd-ae8f-ea4dbf30ddf8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d44efb2e-8c55-4874-87cb-30cfdc019075", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883e43e3-c4e9-4297-9eb9-0de27d78814a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7451bd40-e134-4c0a-a976-34f22b5f96f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c9c4d64-0b3e-4ed1-ba81-86b063d31396", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e3f1fc9-5add-4c31-b84e-f490604e2d33", "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\": 5119,\n \"message\": \"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": "80edf9d8-d707-40aa-93c5-abe9323a5af7", "name": "AutomationCategory", "description": { "content": "AutomationCategory endpoints.", "type": "text/plain" }, "item": [ { "id": "01d3aaef-2c78-4078-a9dd-2fd52aa4f68d", "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": "8d417313-3a83-4eb5-b483-ebbc4e914098", "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": "d7591205-92b0-44ec-a790-5653ef348728", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65937c12-1cc4-4951-9836-64b9d3b90871", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf4a07f-d5f5-4ae4-b9f4-ead26e2541e0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c8ddde0-edba-4158-88dd-3c24af06077d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b480892-c62c-4ddf-ac52-22cd83d7ee41", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15b5da1-646f-4bd1-b6ff-de89c2068d73", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "928ae8d9-9992-4e68-ad47-409686638e24", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f2197f-dcc4-4b44-a21d-72c5331c87bb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cece6668-3b0c-45d1-ad2c-aa604a621581", "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": "8ef6359a-2b47-4250-95fc-3901f107f6d1", "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": "d3c7bfdd-74a9-4b89-8a2a-3a6d5baac674", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aa93fe0-a7c8-4ffa-8128-15e99c3ae050", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "048e83b8-036f-4f74-90fe-7c97b367dfc6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a64d66-877b-4236-90ba-6e00fb6a79be", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a84ca42-9b0a-49f5-9234-7666a2688dba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86168a9d-c9a8-4fed-b23c-90b533194670", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4594a799-9441-4a70-87a4-d9ee125d08b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96be162c-d623-482c-a408-8dfe6dff18cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab554ada-01b2-497d-a248-8e186d138b0a", "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": "9141", "description": "(Required) " }, { "disabled": false, "key": "ids", "value": "7811", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2d7b5026-f12d-4d4c-a406-8490881961dd", "name": "No Content", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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": "6e4bea54-883a-45fd-b333-ba5011de9dad", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59920efc-30fe-4303-9f99-9007a21a8f11", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a628399-eaf0-419f-bae2-d14e1ddf2197", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fbf35c4-14cc-4777-91ee-730a04f12ac5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99165b57-ce7a-4e54-88de-2146020fb311", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e7bac52-4486-4109-a3bb-8ff9982e1fc6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66cbe101-b293-476b-8fc9-b7566884d3a7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5de4090d-b871-46dd-8953-43fcc6f72c77", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "automationCategory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "9150" }, { "key": "ids", "value": "6517" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58b74536-ca86-45bc-9e77-dafa41f78384", "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": "32d65240-2c2f-45cc-b81b-56dc557b87fd", "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": "a8080d54-993a-43cb-995e-fc601c4672ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90e28cab-b19b-4a09-a8e0-6ff592d1a154", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1305bcfa-b266-4f2e-b3ac-158565b02a4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f31560c5-c460-48b9-affc-4917d1d37f7c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa10010d-2834-4876-883b-d35f0fcbbefb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58694036-2ae2-45d2-9228-e2574a3d6c20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09bb3a1c-4fed-4bfc-9394-46c59367a66c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b0a233-56c4-4730-bfde-ce012f4a6f2d", "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\": 5119,\n \"message\": \"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": "1f848f38-f743-428d-abcf-cf6b4a82eaa7", "name": "Business Profile", "description": { "content": "Business Profile endpoints.", "type": "text/plain" }, "item": [ { "id": "dda05e5b-0684-4d56-98c5-57845830848b", "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": "2a1021a1-cde5-44fb-9c79-e23295a90da5", "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": "758978f0-d18b-40f3-ab79-fad36d34ca1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8857ba9e-4907-4703-a85d-c2dad602e620", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6fb01f2-9edf-48ea-8739-dafcd731f732", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "606c6e01-3b2a-4e2d-9587-a7124b3fc6ba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9fcf3f1-73b2-4a0a-8488-d649d108f7c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e7cd237-793f-49c9-92e9-8abafb666076", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ddbb101-0134-458a-a4a1-c5922f4ce380", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c0adcda-c541-402b-8c02-22dc6b05f990", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e88fb40-257c-4ed1-a8f2-9d92c107b7fa", "name": "Update Business Profile", "request": { "name": "Update Business Profile", "description": { "content": "Updates Business Profile information.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "business_secondary_color", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "website", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [] }, "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": "6ef80c9d-2076-4baa-9b74-8de314bdc93d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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": "168ffab9-8fd5-4afe-9a2f-1e0b70504b10", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53774669-85d0-4ba6-a4bd-061bfcc7f7b5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b16cc2ad-a02f-4ecb-8880-443857d63944", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a509c554-4b08-4c83-b358-a8cad392dae8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea983d9f-00d3-4052-835c-f4248a9c1569", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2677eb00-9e3d-4560-91b1-a69e903cb3d8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db6aad82-082a-4cf7-b2a5-87b023ebbdde", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c19ef88c-960e-45a9-80cb-2f8a6a15c718", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "businessProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "business_goals" }, { "key": "update_mask", "value": "email" } ], "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\": 5119,\n \"message\": \"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": "b2e7afe4-8983-4faf-8167-10113db609e1", "name": "Campaign", "description": { "content": "Campaign endpoints.", "type": "text/plain" }, "item": [ { "id": "5fc8debc-65be-44d9-b888-7cdcf2cae73a", "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": "fef34947-59bb-45b0-98fb-3a19f52eb064", "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 }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf16cbb-90b8-486c-9934-8507f3e52fe7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8280f727-7beb-429d-ae77-4a206f78bd9c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48f89b39-ed87-44f7-bdb3-a47b92d80d5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e6223b-a0e4-444a-90ed-a0193c6f8018", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57085fa8-91b1-4636-8c85-24659751de59", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f08bb3-dfad-40de-8fa3-75d71282557f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf72342-6c57-4e2b-90dc-27e1b899d3d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ae1448-da38-44af-9ad2-f6701d3cdae7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "654fe29c-64df-4b44-b461-90536108d6d9", "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": "7cce7b84-2d19-4f07-854d-2e4c1e8fea7d", "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\": \"ALREADY_IN_SEQUENCE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eaeff02-8ccd-4656-9b63-61dafa1a26aa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18e12ddb-c013-4ba0-825f-7487bef1c40d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "596adb70-56a7-4984-9931-4e092b4d302d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c1b3e45-1750-4aa9-be8b-e959b62dd9d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64fd2174-e7ca-4775-b4bb-cdebc2441e34", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd385d3f-60ac-4122-8970-002802c3c47d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "224be310-7ab5-4506-b12d-06a0edc6fc0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a2231b0-f8ff-4cf5-8c9b-6b1c794e6f29", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9857e012-efe6-44f3-aedd-b0a00ce7bce7", "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": "ab16b359-85d2-4ac2-8b00-e670b58c7646", "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": "718b2b8e-008e-4828-a0e1-7f224db5b7a6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed3a52a8-958e-4503-9c21-a16ca9e9b9b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8f3ca6f-ae8c-4e8e-b9d9-7e84704da6df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e56f35ec-b67d-45e8-8e6e-2cfa1d37aa76", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dede97db-dc7a-4000-95fd-24a79019995b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "653b7e45-ac1e-4b58-aed6-ac2829988326", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b920b26-66e2-407a-9ee3-eef42787f149", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e28fb8a2-f430-4dc9-9fb1-9bb525f8496b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ae283a6-39f2-43a8-a868-f60f97914bf9", "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": "bd6512e3-1314-4640-abac-f5b239685430", "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": "5f88f734-41de-4a58-9a58-00639271fe13", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca22d76e-6550-480e-ae6b-00fd5d66566c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c749ebb-b344-4d9b-9927-13292745ce50", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c812656-bda0-482a-8562-b4dc55c666e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "388ca08f-35c3-4e63-b9e9-e07dcea2a5d7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76b8d101-61df-4c76-b2c6-e3be14dbc0d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7024515c-570d-4af9-b38b-69c211d62fab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "789dd466-d13b-4752-94df-83d3c152e0bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8257c20d-56d0-4669-a19f-d60793943187", "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": "33187e70-1700-42ba-9a9e-a1557c0865dd", "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": "3690dece-768b-41e8-b93a-3ff072de0c8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aa1985e-8983-4288-874b-0dbc69fc0e01", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b7cfe8a-aeac-4664-acf1-89b7e6945e6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec19f34-ad1c-4126-96ec-ca62154eaeac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ff92c8-4406-470f-a665-dec252fc2d91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92391718-8e3b-4a6e-911f-5e7a3fc520af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9dd1938-032b-4367-a59f-6b14bc45a8df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a695a2f-a6c4-462e-8d50-41dcc7804ba9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bae03f20-b221-418b-853c-1c28acb58946", "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": "51a91e1e-2cb9-469a-b2e6-3579111c678b", "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": "9a172f4b-af76-4126-bd00-fc7b38c9745e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9f874b0-9815-45ce-b733-ce8f9457a552", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1a9677f-ea90-40eb-b103-5c94ce2c4a6c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "835dde14-df39-4860-b1bd-337a6d337cfb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c78adaa-3069-46f4-a2d3-e1f0120398d5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81bebe3e-658c-4f71-9786-449895a6afe0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b76fbef1-4486-49dd-a20a-03f95c5d4235", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19b4063-1826-4416-a701-6c843ff83751", "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\": 5119,\n \"message\": \"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": "f7a19af1-a071-4417-ab57-b3cdb5b58431", "name": "Category Discounts", "description": { "content": "Category Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "ddb2556b-236c-41fb-a96e-dec96f6ce5ed", "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": "8b0750d5-92b6-4e49-9ee6-4a965251d6e4", "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": "7e7329cd-711c-4519-98d0-65ba2ee23f4c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978331e7-83c2-447a-93d6-7596eff2f9b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046d7d1b-0de2-4afa-91c7-0d775ca226fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb77d1c1-89b1-49f9-bdfc-85291c9972b8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "433306c6-9ddc-42bb-9212-3bee6870bd12", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d94baea9-90a0-4c62-a2cb-70f0379e70dd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b381f47d-69f3-4e67-8086-cfcd74b0ea7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b20fad-9dfb-4a05-937d-6428a3523318", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3df5a37d-6a7b-4127-94ad-9a3b9d1d95f3", "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": "69748a14-67f9-4a1f-906f-74da1171372f", "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": "c7b1c6b4-ed23-4f24-9fcc-7418767f3379", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2d0b66-2d53-45ac-a60c-124f18da4905", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "112be292-f750-45c1-b4e9-77b630c26396", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc97cb48-80b9-4485-9e2f-c28beb141c7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3039ff5d-8946-4560-92ae-e3383c28836e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06c9163-617a-41d1-8b25-c163dd54deda", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5429ee42-129f-48a7-9476-7479aafc4dc0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a107a47-c287-4da6-aa65-4ede6eff4b6f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c9fe995-4360-4181-b3f7-12f20878ef78", "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": "317f5cbe-16d0-42b0-864f-6cbeb01fd60d", "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": "f379ad55-fae2-40c8-bf57-1c1a9aea1564", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38425e2a-8338-4b05-b6b7-2f7096151567", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "512c5569-e7c7-4383-9dce-312b6805f693", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3934efa-ae22-479a-88d4-faba898fd291", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89c35da-c39f-4a59-ae8a-2fd73ed8bc67", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f79a02c-8921-4c08-8b37-fb7a185889ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da544ee4-7d4a-4d34-b69b-f607a4b54841", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fded0fda-e6d7-4881-b60a-f84c5c1d4cf5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd3b684c-8703-427b-927f-50638a602793", "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": "b5a2133b-3fad-47a5-8bfd-20429c3da9f1", "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": "a72291e3-e9b8-47c5-a39e-b7c7ed5d8fe0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "034493fa-0a54-41ba-bde3-e1e2ff35f0ab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c00d5ee-ad64-4488-89f0-b8037f6fcb2f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "935bee38-708e-487b-9d58-fc11999da899", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d6de767-cc62-44e7-8d4e-7ffae1f16d6c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add1a379-8781-4db6-ad9c-ede96e5d4faa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecac66af-64c1-41d1-be4d-32d69b0426fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4962c908-8cf7-474d-b394-dd6a2206100a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a7d7076-8ee0-4fc6-af05-2d0c604a7d9b", "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": "0aee41e8-febb-4360-bc3b-b809ca7947ed", "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": "cc1d6507-4b77-4337-9c8c-44253b783d80", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3e8d48f-c183-4ef6-8670-9c33be9e7f0b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5180083b-d1e7-4a87-b5ad-7bee4f42ed22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81b7e952-1b71-4e2e-999b-a11970c986b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b52d96e-bf68-48f6-b88d-d8b7bfbd1e96", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e46f28c-9e8d-440f-9454-ba40c40a1dd3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5029c483-ea18-4141-a54b-b2839c51e76d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1bb9c1d-142b-4ad6-a8b2-fb6cc1cc187d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "661e10fc-cbeb-41b5-b34d-6bd5a222f0a1", "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": "discount_percent", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "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\": \"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": "bfb98624-79be-4605-ae23-b03129ad43cf", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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": "e6998aac-ca35-44bb-b3be-f7ca960b2dd1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce1010a-5dca-424f-86b0-4b34bf1db5f7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0030dbc7-1f33-47cd-b138-73817e21c39f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cd54e61-36c3-4da1-a5d8-d17a229f72b5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e1baa4-c806-4273-bbcd-2d4036a22acc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907d2469-d15b-4a47-bd0c-df24ac458ad4", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c157f47-6eee-4ce3-8315-2cb1600edc88", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9377ad90-a8c6-430d-9d04-502e83c20578", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "productCategories", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce0f1e67-48c8-4a96-a632-cb8d32c3c83b", "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": "df8bbf04-8a9a-4f73-8757-63ca133219b7", "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": "f663cc6a-3a21-4de0-b88b-ff1b56e7c002", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a32fe71e-1fc0-4d69-bba6-6b4fd638aa99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "117e5fb2-b86b-44a1-bc41-e2bd2fd7312c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4053070-be68-4866-b276-46b377cce4fe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9abbe669-1bba-4cba-ae2c-d57249bcd1e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1b1742-68ef-4e66-a869-edf1b449a3c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8de28bf5-79ce-4073-ac35-2dd841070043", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93369d28-3562-48cb-87b8-cdc9d7e598d2", "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\": 5119,\n \"message\": \"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": "b416f282-230b-497c-a623-d04fe09fc764", "name": "Company", "description": { "content": "Company endpoints.", "type": "text/plain" }, "item": [ { "id": "d01f4628-d651-4e3e-a232-08de4b188dae", "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": "028d3cec-54b1-48de-91b4-efad3f341707", "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": "171a6511-9b9e-48c9-997e-013f4cbbc76a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "563ea6a2-517c-4cd9-996d-0966b2e061a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a832bfd4-68bb-4485-8bb9-383017f331d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f8b7557-6733-47f4-8764-45c263655d61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1afc4104-4d8f-4913-affd-a024b4fe0b01", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "140d7028-a6bf-44a2-bfad-830cb6c6379c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eea94ca-26ff-42a4-a598-15eece806298", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49bea435-a5bf-4732-8d7e-1e176ec5bb5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcb8e674-4157-4e2b-8394-b78835d2e6fc", "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": "d8031fd8-9236-4463-b2dc-54022352c354", "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": "4c85a65b-15a4-4163-b7b3-a16a42f47b0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31e15bd8-f6f8-4716-b57b-3b80846fc893", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "889e0aec-79ee-40cf-9739-fcb2337ce103", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "147b168a-4cc2-4ee2-ba53-3795ff33f1eb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "391eb6db-f3e9-420c-987f-5a004150ded6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8267e677-0a0d-4f94-9cc1-d88019fb38f7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfe0cd2-29d7-4764-abce-24da0a678f82", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f004bf-3f01-46a7-b8e8-928f53b9206f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec02e247-a471-410c-8161-b2c4df082d3f", "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": "e8c9f256-d721-422d-a6e9-137d10c9bf88", "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": "02f45a9d-92b9-453a-b8fa-919b63674f56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ccfef2-d9cb-4f89-81dd-08f59fdcd7f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1445a52a-6285-4c14-a3ec-ce415d73014c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24221ae-97ab-4aee-a84d-62fc16b4eb32", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdff123b-8472-43fb-98c3-a2278c9e39a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd42157e-c643-4c68-b028-6c8c5ccdbe8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3673f7c-b195-461a-8ff3-d7254fdb98cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a3f55a1-ecce-48b2-bebb-ace47f1db4b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c23263b-f695-4f9d-b0d0-6b6fa32a5942", "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": "a49fca76-45fb-45b7-b604-168a8b228d2a", "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": "d149320e-acbd-4fa6-81b7-7a07e150b468", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "669cb185-fa3b-40e0-933c-59a4c8b8b98c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9402158-6d4c-471b-a476-eff78be3059c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add46e5a-892a-4e02-bfe5-e4176f9e7c3c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01cda4ca-4f69-4b8a-b30d-56aa1b0e9530", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e49391-16da-4b01-87b7-765c270eb0f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "809267c2-d67e-41d6-8726-dbad42bff5f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b42e642-a80e-46ee-9b6d-d95b066e9107", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb84f05d-11b0-43a7-8160-59b1186effec", "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\": \"PERCENT\",\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": "7cc0d9d8-7680-4bfb-87d1-476bb2903c90", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa082cb7-8c13-4fc1-94e3-836d3a4d8113", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33b833dd-9cc3-47f2-b572-8d4ff19d658c", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37a23d01-4e36-4113-ab43-b79f654294db", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4198723-488a-410e-89ee-a542c4618c20", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa4f39d-a047-41a2-bdea-ed4c3266bf7f", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d39ac1e-74e4-4ae4-8857-a1c7a9b4de58", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b28e0593-2416-4a49-a245-dd516cdfc3d8", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f1dd22f-72ba-4ec5-9582-6ca694973f36", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1781a8b-500c-42ad-a289-f05be02c442b", "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": "35f42e91-419c-4a06-a76b-aa1a78bf092c", "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": "21fb7498-0475-4fa4-a4cd-92fad70f3039", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "534fdb79-8b8b-4edd-b030-5239e7d8c6f4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbfe39a6-75f1-4892-a018-204e55fe7a37", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fb4a32d-4bd9-4571-8cf8-576959149fa0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe65dcea-4b62-4e58-b65b-32226ab5fab8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a07dd87e-734f-494c-a1fa-1cc4eed303f4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50b01b9-6f73-4d36-af09-ae0cc62981ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59d6cc95-798b-4541-96b7-22bb13088f3a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5dd1f3fe-581f-4122-a2c7-3dd6ee0707e4", "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": "16be451d-b55f-4dbd-9b4f-c8d2baaaac82", "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": "31e2f6ff-d609-4424-a251-29cfe25353ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4acf5250-3870-4bc3-80f5-e23af4fdd653", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a4b542-0b0b-4465-94c0-a1402c6da181", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "852bdd49-1d59-470d-99e0-11c26c9ffd38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3d5126-cab6-432f-bf90-4f800fe1099b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241fd4f1-0ad0-4e61-a4a0-44b7d2ac3da5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d90cfd-48e0-4c7f-b88b-89a183b2fca7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af131431-855b-4220-993f-e99e8ac2f748", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa5bb56e-2387-47e3-8f71-c6adadbf2eb4", "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": "cd5e81a7-92e0-48be-83ec-32167235213a", "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": "5c9d0794-c412-4603-8900-6e6553dc22b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "decacd8d-2948-435f-830d-d44da3fedc71", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd55c044-124b-4670-89bc-988fba09ae77", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "610c3b3c-a2e0-4892-b37b-8b17fe6c95fa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780e1d34-5d31-4540-9e05-b77a651de0a7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc8cddef-d05a-4f6f-a462-1c5425231002", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8640a9f5-0851-4b4a-b6c3-281103b89e0f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d9080e-b9db-4d5d-a4fa-8eabead56a5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcb939e9-3163-4966-a70a-23d20c31f4db", "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": "e01c6e1c-77b2-4c7b-9219-ef5af703ab27", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c32261f1-9bd7-42c8-ae2a-ea5784dd830b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aff85c6-e188-4029-b37b-1f5f1d5c3e08", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a461ae-ff70-4f5e-9251-1a8ff01fc05a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a15ee2e8-f9b9-4a80-b124-ada02e40e10a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4f1dd4b-e71c-4348-a07b-c480da905447", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "057ce2da-b8a6-4b33-a967-54369638e33d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e4b915-c226-4f3f-bfc0-9f425e4e2e9a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea86b59-f5f5-4220-aff9-dbec4351394b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1126fc8c-2476-448b-9123-b93d85152f69", "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": "7d9ad980-5463-4c7c-b0b2-930413d3f201", "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": "a45edc5b-c6f9-405c-bad4-34a28b98eb7d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e43155af-29b0-402e-ab1b-15a0a17a16b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a68432-4d60-4382-b87e-3c6d8811a228", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4704b2-92ef-433e-8d93-ea9049d00616", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de523489-73ea-4403-a1fa-dd83520215b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eca03b68-d5aa-4497-bb72-732c9dd999e1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8705e8d-430f-4668-ae1a-e837ba8d8465", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab928a9b-3897-4d0d-b4dd-729bff8549ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ac18f87-8b16-4252-af7a-a5d7bb63e71c", "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": "26e08a23-521e-4d0b-a754-a758153744ca", "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": "7577b398-3ba9-4002-8447-e600500ba5c6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7971155-5c7d-48ba-a53a-85c5dbf94a43", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1191d86b-5e43-427e-9c64-b736c1c76834", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "836ea65a-214f-4c1b-b032-e4e461e106b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22878b58-4926-4c6f-a0a4-6a6cbc05a954", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "744e0c75-52d7-4479-bab5-64ebb956a650", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea9fb06-0b1e-4c56-94e0-6f447f374a3a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105c7b4a-3620-42d4-abc3-f40e7c1cb6ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf73159b-355a-4efe-8443-2b3dafb6bd01", "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": "billing_information", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "last_updated_by", "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": "16c8a0d8-9584-4e79-89b8-2b2d6a07493a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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": "807ba808-cad6-49a9-bc13-e0bda65214b5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1481338d-3a43-40ec-9688-825599d722fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95247310-f203-4679-ac97-643432647983", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0c24e6d-ee2f-4ed7-b07f-efa551029119", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfab9a5a-f4e6-4176-acb2-d8b7f22435ad", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f935bdc-31c8-4b12-b002-c0fee67a41e0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aedeb71a-6220-4c4a-be73-335b7bb1658c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3149e5d8-0021-413c-9ef8-c690644bf297", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "billing_information" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff3be9ea-e86a-46d0-b86a-35e8ea9bebf0", "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": "cc091563-7f37-4dba-852d-fe1d0e08cdda", "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": "b3519137-fe52-45b4-bf34-c8039c7fea82", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d563267-1e80-4302-8389-4ddfa55d903b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01c5fecc-131e-4787-88e9-5c2654b38705", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41d1251b-85c8-4425-b8b9-44f9c3694bc2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b1a307-c4db-4254-8c5d-fa27ed4c5840", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb34777b-54a3-4971-9adc-6b8b2dfcf727", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a1437f-9316-420f-a1f2-262b8e5110a1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50542758-315b-423d-829f-b11bea910d50", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96919dbc-9691-469b-a7ab-facc3d46deba", "name": "Update a Company Custom Field", "request": { "name": "Update a Company Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Company object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e60aca55-40e7-4092-9528-42e3e6f949cc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d678370-75e7-40b9-ab94-5c3864280a3c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0591c6f-abc4-4561-9eea-eb7e32b2e19e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af2284bb-2682-4bfa-82b9-76b80781e4c3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc07d430-2bce-4da5-8df0-d0ad9c3e92ff", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0a14cf-e4f9-4666-afe9-1878ae9f9956", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40b53be4-a695-412e-b5ff-beeff7cb38f8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f123811a-b537-4c56-b0fe-a1e5baf83eef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "974f6da7-4a37-4b8e-99df-f856a58fe239", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dfe85eb-783c-4ed7-9992-2786c3398398", "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": "320f54db-ad89-4014-a95a-4b513cdd9736", "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": "db2706e1-5393-40d4-a18f-a154f0c86676", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddd7bbff-5294-4836-bd96-2b07fef23947", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db2d8536-8bd9-4873-bd00-cdb1ceff4f76", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e9bb9c0-5c92-4b07-a70a-c306b812117a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8d47d98-6b01-4746-81d6-25626375ac90", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce943655-b9d6-4e8c-a9fe-e51ed421e14a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12b5be73-38b3-4214-a89f-d1086b3787ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1b29160-a644-42bd-ad3f-a45ed26c1b0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1dd3b8d-ba57-4880-98f6-76e28314892e", "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": "d139e4c2-1c46-4727-a4ec-a9a24c652c87", "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": "a4d0ac56-5806-4d46-a7fd-d6790529e87f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e1e5b10-d225-46b2-bf2b-5d07571f31f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65730613-24c7-4d97-b4b6-6aae64e3bde3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3f86df8-43ae-4433-a301-79755659e8f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0636c610-14f4-46b8-ac1e-dbfeb8e7e0d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96dab3f0-3f71-4c58-8a29-0bfcf0006b8f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93271a8a-b8dd-4639-9212-3cfd26e59724", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23cc74d-cb79-4567-841a-00892798e83c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb240691-4264-421e-97cd-182d8d24ab88", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "123026d4-38be-4d95-b58c-d0dfd294489c", "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\": 2647\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": "2c0ff801-1767-4943-826b-2d30a679d4dc", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d5faa7-2604-4f2a-a5c4-0e43c0b98971", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b549b07b-0496-4d28-aab2-236e76eea03e", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8538976c-b3e2-4539-af4f-88eb02aa0b51", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "873f25bf-57b1-4944-9913-1ab8164d7242", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a769ed63-8103-4632-bf0a-71ad483c3151", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83aa0d92-6753-42d3-83d9-3795e399e861", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efdf5c2f-1709-4c9b-bb8c-b955008a8211", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1d2d291-2645-488d-8904-9a533628b9c1", "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": "3024538e-108b-4649-8315-1a8782db4b99", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8961adc2-0a79-4fd7-adfa-afd952f6b509", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe3bf28a-83a4-4803-8ac2-81fb3b683b26", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0442479-1dc2-4f04-82bd-8039a231ba99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dbf1ff6-add7-4b0f-bc1c-20321fcf19c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b84f319-7f8c-44ea-93bd-5525a2901f76", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad849477-a517-4098-9fa1-2e65b9c85d6e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "882825f9-7c4e-44f0-8fa1-533013e2be5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdac1b1d-4346-4cf3-930e-6ecb2bd80fda", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab62fc4b-154f-43b2-bb8e-20fa0d5c7aec", "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": "9bc1bd80-92bc-4a57-9d58-31e82bfd8638", "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": "e799eb36-f54c-49e2-8406-80b695d7f9c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf43eac-d215-4be7-a48f-3d0d2ad94700", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "873afe23-f1ad-42a0-9e0c-588e57f8aa9f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225dd9f0-ce3c-429a-8ff3-33424befba35", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bec14ce-4280-48b8-b73f-2cb14e671369", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91b71f76-dd87-4fdc-9ec9-ad258cdbcfba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be0dac75-219b-4098-894d-9171e8db0d11", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbe55c6-736f-43c4-b139-0bce4ffd475d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75a88032-25f0-49e6-b5b7-693276658136", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b9eb06b7-9579-47e8-a97c-6fe66bb04e6c", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7013679-06cd-40be-aeef-1cc370dfcf7f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2386ff60-9f65-41ac-b501-a95837d13f16", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f0b161a-d061-48c0-8ac0-7902f0318364", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd71b259-60fe-4a60-884d-45e650f4aa1d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb0ccb24-01f6-4fd7-a271-fe26ad4fde1a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7abc6d8c-ed04-46bd-8b22-0dbc92dd0daf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b968230f-9f35-4478-afb5-063de6b8dd11", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd969989-f875-4c12-8976-dea00d030756", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "companies", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "706c5cae-4967-438e-829a-705198f03b09", "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": "2e63f5d7-cb65-4e5f-8ede-8cd21cbf70c1", "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": "ffeb60c4-8cac-47fe-a85d-7b00da536d7c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f75137-d425-42ef-ab91-60b814eec1fe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425b32bf-1f29-4518-843c-e1c0c560e97d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39ba46e6-123b-46da-9ea3-4202390c2e02", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba7a9312-55a5-4cdf-9ffa-2852c86f8438", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60b85571-1429-497c-bc7c-33f4a441c185", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15087ce1-eb1b-4d5a-9853-5fe08d07f22e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0a8de43-90d1-481a-b6b8-d2967c71d728", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd9480b5-297c-4a9b-ad31-fe92ee4a975f", "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": "67ab719e-31d0-464f-9449-b56fe658696d", "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": "2acd0f4d-c980-4839-86d6-c96f1c382d6a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd14a49-e643-4764-aa5c-8563d3311163", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c8d8d91-eadd-4207-965e-2996d7b3b992", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a78ba857-137d-4208-a457-d82a73560961", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37c965a1-e9ba-4dc5-9c45-a5cce276ed88", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b83430-4355-4dc4-9aef-3fa4caddfef4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da2394e1-f40d-44ee-ad19-8d73b1229fcd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b7c33c-a66a-4aa8-ab18-3b482bf26098", "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\": 5119,\n \"message\": \"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": "45f3d293-c618-40cd-8a93-7465f3e8fbe5", "name": "Contact", "description": { "content": "Contact endpoints.", "type": "text/plain" }, "item": [ { "id": "6ae499c8-dbcb-4b6b-83fe-c5aca1212620", "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": "9f17fd2a-a3c0-4024-a1ae-d8a42f2f5f91", "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": "2d3a5640-19ea-4e8e-ab90-c6540df3c76f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a51d9a5a-d819-40f8-852b-62012e2b67ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1900d7db-4594-4c6c-a0a0-cc1a61c8e7b1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2535f512-f334-4cf7-9904-604bc0fd2b61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c335491-ebd7-4186-961a-0398a97371db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bda17ea-810b-4124-bcc7-6650c34a4c6d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a461f294-328a-43bd-8f69-8927ec88bef3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2a1e9a1-ba3a-4c76-87ab-c047b8687dfb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eed92a73-4e9f-4ee1-a2ac-2e2f42e7dff4", "name": "Create a Contact", "request": { "name": "Create a Contact", "description": { "content": "Creates a new Contact.\n*Note:* Contact must contain at least one item in `email_addresses`, `phone_numbers`, or `addresses` and `country_code` is required if `region` is specified.\nOptionally accepts a `duplicate_option` query parameter which performs duplicate checking by one of the following options: `Email`, `EmailAndName`, `EmailAndNameAndCompany`. If a match is found using the option provided, the existing contact will be updated. If an existing contact was not found using the `duplicate_option` provided, a new contact record will be created. When `duplicate_option` is not specified, a new contact is always created.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "duplicate_option", "value": "EmailAndNameAndCompany", "description": "Duplicate check strategy. If provided, performs duplicate checking and updates the existing contact if a match is found." }, { "disabled": false, "key": "fields", "value": "string", "description": "Comma-delimited list of Contact properties to include in the response. (Available fields are: addresses,anniversary_date,birth_date,company,contact_type,create_time,\ncustom_fields,email_addresses,family_name,fax_numbers,given_name,id,job_title,leadsource_id,\nlinks,middle_name,notes,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,\nreferral_code,score_value,social_accounts,source_type,spouse_name,suffix,tag_ids,time_zone,\nupdate_time,utm_parameters,website,account_id,assistant_name,assistant_phone,\nbilling_information,created_by,groups,last_updated_by)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"UNKNOWN\",\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": "921a12bc-2d5a-4b1f-acaa-669724696c16", "name": "OK - existing contact updated", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"API\",\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": "09411b07-93d2-4e14-bc5e-4c80a64a2cd1", "name": "Created - new contact created", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"date\": {\n \"value\": \"\"\n },\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"groups\": \"string\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"score_value\": \"string\",\n \"tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"API\",\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": "26384243-5185-4e83-9191-ef4df55e5d4e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ebae3d3-fb63-4957-a2d1-ea7891d0d375", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a67d7fdc-fffa-4e61-8dd4-9e9857eabb14", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "133e86f0-5ccd-447a-a4c9-f4a6bb5155f6", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25711687-7ff1-4250-8f7e-c180c9c8b651", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83efa900-402d-42fd-8684-ee50618b9d0e", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6053bb3-9c54-45a0-ae9d-fadfb8a4add9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfe4b64f-00af-448f-9841-28949a5ee9b2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "duplicate_option", "value": "EmailAndNameAndCompany" }, { "key": "fields", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"company\": {\n \"id\": {\n \"value\": \"\"\n },\n \"company_name\": {\n \"value\": \"\"\n }\n },\n \"origin\": {\n \"ip_address\": {\n \"value\": \"\"\n }\n },\n \"prefix\": \"Dr.\",\n \"suffix\": \"Jr\",\n \"website\": \"https://thryv.com\",\n \"anniversary_date\": \"2015-06-20\",\n \"birth_date\": \"1985-03-15\",\n \"contact_type\": \"Prospect\",\n \"custom_fields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"email_addresses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"job_title\": \"Senior Software Engineer\",\n \"leadsource_id\": \"string\",\n \"middle_name\": \"Robert\",\n \"owner_id\": \"string\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"preferred_locale\": \"en_US\",\n \"preferred_name\": \"Johnny\",\n \"referral_code\": \"REF2024ABC\",\n \"social_accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source_type\": \"IMPORT\",\n \"spouse_name\": \"Jane Smith\",\n \"time_zone\": \"America/New_York\",\n \"utm_parameters\": {\n \"keap_source_id\": {\n \"value\": \"\"\n },\n \"utm_source\": {\n \"value\": \"\"\n },\n \"utm_medium\": {\n \"value\": \"\"\n },\n \"utm_term\": {\n \"value\": \"\"\n },\n \"utm_campaign\": {\n \"value\": \"\"\n },\n \"utm_content\": {\n \"value\": \"\"\n }\n },\n \"assistant_name\": \"Pat Doe\",\n \"assistant_phone\": \"string\",\n \"billing_information\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "773ba62f-da08-4260-8cd0-096dddc37920", "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": "957af2ca-1012-4268-ac98-303215828bc8", "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": "478ed022-19b5-4dd3-9db4-8058f248ab84", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82f3e17b-9a0c-475a-b5ab-082f2dc3bf16", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb694a7-306d-4dfb-9cc5-d339a7a9a02c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205584ab-1b2e-44b2-b529-59e6c1d81dff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "845db08a-b99e-4245-a778-cca7c06b49a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c66164-28ee-4443-8231-c590f9363560", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd4a4d1d-8591-406b-a0a8-3400c8ef86fe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c56b3c36-4cb6-4b78-b622-c8ed14855486", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e167297-d0c6-4d4b-b129-9a0ee027e9f9", "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": "6933be89-9030-4961-bb32-a7f7b575316d", "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\": \"API\",\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": "6f6dee28-a92c-4319-93a1-4bed72a62aff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aa567ab-9c87-4a3c-a467-d6f5d1f69c2f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "082e886d-292e-4a76-a23d-b8aec64a3954", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "574dc355-be8f-4247-b019-4f741316710d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "395f45be-b0fa-4e46-bee7-ac5cce845e21", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2521594a-11a1-4c75-834f-4c17508121cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc1234f-edd1-4297-b30f-cf92fc4b57ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c5a99be-4d0b-4928-81a4-bfff7fa4664e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "923ec939-a5d3-4d0c-8bf4-15eab57e5890", "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": "a1912ba5-6452-4a20-ada7-427110cb65a8", "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": "cf02d021-f51b-455c-afc8-54e55c033cca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a835e54-906f-4786-9c63-0ce1a0f05a1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ee3886-b97a-4219-a2b4-da42157c8181", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79d15b8e-7c88-40f6-8be7-c25e9aa1fc97", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e224b0d-c116-4541-891d-e36100290dac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc719557-bcf3-47b4-a017-65808b9920e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40378b19-01c2-4767-9c1b-71dd779706c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee95300a-8de5-4c3b-9f09-9a78bc534eb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d98a8745-84bb-484a-ba7c-96ca4f98d939", "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\": \"PERCENT\",\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": "9092d6c2-ac6d-45ca-ba13-aa58b7005001", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f139c71c-dee3-4482-84fb-eb374e2eecec", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59768b2e-97cf-4373-927b-ceacde50c101", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab9d305f-1594-497b-89a9-c6205e9c5f72", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77531968-d3ef-4366-8c79-b052d87299af", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e549fcfe-e76f-4662-a9d3-f5e880102967", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ac9e2c8-41ba-4a60-8379-bb200c4dfc4b", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c88fc5a5-297b-46d2-b8d2-6d9ddc094efa", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad14e3b3-61e9-43f0-be53-990caa19ff1a", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "772107aa-98ce-4d80-b9de-0a59c7a9664d", "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": "ac8c68b0-8c91-45e5-a136-7e697e733a06", "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": "912bb98e-e435-4450-b839-48794e492a86", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb5adad-1c82-4901-9ad7-f592640b69c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c50e09-89b0-4e88-9d19-c3d1702306b1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3facb791-699f-4475-81bd-1e859c79f484", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828f7a16-58f9-42f5-b824-2190e3b29f5b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ca39ee-ffd9-4959-9834-a26429dd3303", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cac28dd-51d2-439f-865c-c286081a364a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f19ec3-2b6e-4efd-b63a-c1fbb9403506", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5718e7c-86c2-4cc3-bf21-c4925e940b86", "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": "e9a4ec8b-1643-41df-aaed-e526ee2f8654", "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": "e38fc2dc-f17e-47ef-bd44-723d875a35bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de1e5432-e518-4d7d-b32e-1a2c09609dd4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1842065-c834-4d8c-906c-dc6ee7564e29", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8cc0c57-1465-4662-9b8b-b3317b0100c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b78d13d-3046-4a16-8dcd-e44c0abb52f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07ee66e3-8f34-498e-bd0d-362ba742dc39", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c26cb81d-3455-4272-9c67-7ed11c33ca63", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "663af81e-533a-4d78-81f0-d711b7919697", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2034d3e7-326b-4f56-86b4-df3c3aae6e71", "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": "cf44b5d1-fa37-4965-acb0-a7bdd8c8b6ce", "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": "234ef3c0-b10e-4056-832e-95b6fc541e5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5abf84e-5069-4bf6-90dc-7a9543649355", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd0bc0fc-b97c-4e3f-a3aa-058ebd37c596", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1da8368b-2704-4058-8f98-a1e7615d0f7b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "231af9ca-270b-416e-880f-cda7165643d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e6129d5-8c62-4ea4-a761-b3893582f59d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49d368bb-ef7f-4329-aa23-24dc58426383", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2340a41-5000-49f8-9d35-22e8038785f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f2a6818-67c9-4cb8-8071-35b13384c940", "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": "99e7e2e7-1728-4fd2-9626-a75d9c0c3600", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2ad40c3-00b1-4753-bc87-1b27668f45f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85457cb3-278b-4c40-ac28-7c65874843eb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f113557-3561-4812-9992-a002c1d6c33c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5537b926-a9f3-46da-8c00-86796d97871e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c9efcc-0309-4d4b-ad20-2fbab2503427", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0cb6585-969c-4780-ab94-6aa6766d7ecd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "464ebda3-5ae1-49d6-a817-a8f514fc2792", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "472eb858-d5ea-4e14-bd43-7cff2c41e92c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb3a80fb-c08b-4b15-96bd-3e3f5d026b29", "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": "430fe654-a8d2-4d4d-86bc-00290df7695c", "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": "e1a38fc3-e2aa-4815-9ff5-216d91911253", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "578dad60-d1f3-4e00-8be4-8b59444f1dec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d819a0d2-47bb-4eee-aa56-40a39cad8de0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f28ef22b-0095-490a-b1d6-80c9d7bbd280", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e914059c-be5d-453e-b347-24ac04bc2012", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d8715b-c65b-4350-874c-de8c7edec910", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a032ec87-e841-4a4d-aa88-4017b9fe13c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b742b23-154d-4bc4-8e41-3729b0b6eabf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13394d45-b543-412c-af78-e1ee5b517728", "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": "1a89ca27-743e-4e54-8f7b-3c8791335c39", "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": "86d72d20-c3e2-4236-9e4b-4eb5f627c1ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d71a287a-c8bd-422b-8c1e-0fafd1f22107", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdb49d21-6391-4fd3-8deb-6ba3309c78ba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37bd22c3-de79-4dff-a1d6-fbe9dd6f0e3e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ccdcfb8-b6ae-4671-b830-a9b7c611113e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5832fec0-7e11-4687-bdcf-f9c737dc291d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8031e4-4a31-47d0-8991-1390215b3df3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ee6e10-f030-464c-9b8e-77a9f370044c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9affe24-b904-48e6-848d-cb52b0fad76e", "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": "8bcc1baa-882c-4cce-9726-91c1d55a2a59", "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\": \"API\",\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": "e14957ae-8892-46a8-9c0c-d7d0b096f890", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6407197a-8b46-4873-a55d-7aecb344ed9a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcdf3e39-3e6c-40c5-97dd-30e677f16009", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93fb99ea-829b-4b5a-b6cc-71f780ec0c95", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1de75c08-a51b-494e-87ed-9208e312011f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dede7a5-62de-497b-97da-f96aeed88949", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7867d755-d83f-474a-a510-750492375605", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93639f9a-e4fd-48b8-a8c3-aee901d61592", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bb1340c-613a-4beb-b306-9b7c161d9718", "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": "c79edc13-1308-462f-900a-6a0ca606b35e", "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": "2d8b796e-941d-4bde-b7ed-61411529edcd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d90d099-68a0-439d-9e78-b2996bc01ef8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "128d774c-292a-4061-ad73-a09e6cc130c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9816bf3-fc7f-4126-aa0e-dcc531a9c536", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61863bd-2dd7-4655-8378-6455a7d8940e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249fcbe9-2158-48e3-9bdb-afd47c005c16", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df1aaac2-0e34-451d-8849-1616bf070f20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fad41e1-3f9b-47ef-bf40-2457908afcbb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40c0f70d-4775-4747-98a3-d305e73b3203", "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": "birth_date", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "contact_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": "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\": \"UNKNOWN\",\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": "1ecac0a3-d776-4510-8d72-fc201419369e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": \"API\",\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": "fcfb01d6-192a-40fe-8243-adc112baf8de", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c290d24-8caa-416c-b4f6-ee0343585343", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad270154-d4c0-4c82-a07e-c1874ec0a1c9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f71d035d-cde6-43d7-9e46-f3b6c3fcbdba", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e00dca9-8cfc-41be-a8ca-10810d6e4cf3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a8d13a6-bf59-4b8c-914f-e72ad51323e8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "560c3636-adde-4449-b1e7-98a3c36c7d85", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658ad3b6-fd7d-45b5-a6b6-40ad79d49002", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "custom_fields" }, { "key": "update_mask", "value": "social_accounts" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58eb6141-9cc5-448a-aedc-394548f848e7", "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": "0dffe0ae-537c-4d0b-833e-35a6e1961428", "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": "1cc30f0e-4f10-4c77-b77a-c0fe464fb692", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1bb1bee-7c83-4109-91ef-b512e6d67bec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bc4ad17-0fcb-4224-859b-09b0918f7962", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36fe9d2b-49fa-48cb-bfbb-315b3e85f926", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac15723d-af2b-4eeb-b55d-9cb63105d4db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6b4cc34-cc2f-40cc-a22f-0a2882592654", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d1a5b44-8366-43be-aae3-76b8ffdc4a9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f75026d-bcf2-437d-a5e3-7a66081dfcd5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b8e4dd6-6b31-4c47-ba1d-661b52880f94", "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": "d8285fdd-437d-4f3b-a71c-3b842004ebab", "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": "29b8f48b-90af-4e69-865f-76c5bcb65334", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f5b6930-e57b-4d23-9960-1ea17dcc9f74", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2f0bd42-f688-4278-a4bd-72753ab6f3af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c118f4-ef2b-4f50-a446-9c5d82d010f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2453600e-3cd9-4afc-8402-61815113cea9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "188309e7-a89b-4aa3-a85a-942a1ef9f1a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f1bf8a0-7913-4d54-b3c4-e4a74643bb2f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "957087f8-a1a2-41df-85a7-7439f747ed07", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97099c70-3f52-4486-8e70-11af93d5b54e", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2810e48f-6f4d-468c-8d81-93adcfebe9ac", "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\": 2647\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": "52ba009e-6b59-4e9c-88da-6073bb258399", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17cbfb16-76fa-427b-80d1-bda537a44217", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "192ef8ed-c077-46f6-90ef-08599caa4d2d", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62bdfccc-db66-4e27-9826-cd068acef537", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b5b1cb-2ab0-4601-81d2-e255595e2f96", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ba7776f-789a-4384-9c44-b92d95301f87", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "589d2ac7-2307-4b46-ae89-b38dca0c90dc", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0116ea9e-db8d-4c7c-acd8-b78cbb284863", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96dbecdc-6dc9-4ef9-97fa-46db08870f39", "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": "72852469-30d3-4c3c-8c49-488c0c6b5635", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4e6104c-d67a-4ae5-890c-b3663070b246", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f61884-9618-47cf-87a5-f13df371e320", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47653b0c-a721-40de-bf26-64bbe2fe5c0b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d00fabb-6514-4124-b30e-eaeb0c4129f7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68bcf1f0-8a91-4fc6-8d2e-ce52e968ea3e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a51da4d-447c-408a-9b93-66d233928989", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e90230-027b-49d0-970e-67e5621d0368", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "826ecf45-a352-49ac-8d06-a6a2f4f46c1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b9b8231-c4ee-414b-849c-3d9e24e316f3", "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": "29098d54-f382-4e4f-b127-ab6033cb5b4c", "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": "406566cb-128f-4c80-9fdc-1693cce8d2e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72dfdc2c-9e2f-4140-95f6-e9e7d22f0871", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a50ffaf7-9ebb-4d9a-a109-5c129d97f1c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5347f3f-67ff-49aa-ae6b-573fb8e5483d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178baad8-8e95-42f7-ab15-eb31439fba55", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b283dc02-5b0e-4df4-b955-66871e0aac14", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99df3bce-7669-4f98-a525-511f98dbe407", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5624100b-7ad3-4ac9-a898-0297c8ce0bf9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37c9fa4d-c882-41f8-90f1-857581253fc0", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67ab9c37-9745-4423-b4a3-e81b6fac529a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5ce59c6-1c48-4cc1-9ead-b9960e5aa90d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd0b65be-261e-444e-907a-c8095efc82ed", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2534d7d-eb4e-4321-aead-878e8a8f77ac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5a6bbc-6bb7-40db-88bd-6f8acb0cb305", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f16e68-84d5-40bb-9d34-8f15fc07d54a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d94c7bc-f495-4a11-bfb6-b04e9f176907", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ed764c8-8d69-438e-ac26-06f201256893", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79aa7d79-de10-4433-a3a3-a9abc9a92c61", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61c5ee48-2ec2-4bf9-afbf-521960ac0c44", "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": "54a35eb9-fdca-4e01-a419-0228ec67979c", "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": "86894a87-c947-4e57-b81c-4bdc2ee4686d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c61f970-4568-4777-8fb2-bf8d841fd37f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28fb5edf-6b20-403d-9e54-43691a0c20ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717fcc70-d827-407d-a615-9a2f3957e82a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "debca2bd-8315-4aa4-8c8d-ec2909ce0256", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52fcacb3-010d-439b-b4e0-c11127d63dc0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7697c026-7e05-4c34-b339-835cf09bad5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6024466b-3f39-491f-9ecc-0061f653910f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2316734-51ea-47c4-be40-b3ac95ea8ea3", "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": "max_links", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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": "c5cba821-f469-470a-9880-458f8e53a876", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Spouse\",\n \"max_links\": 1,\n \"create_time\": \"2024-01-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe958848-7a20-4a42-8ce5-74c409c77f07", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8da14048-9f4b-429a-9f4b-dd254bce52e2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb1059df-d307-45f4-ad4d-d4525276f533", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc88b72-fbcb-416f-b23e-6f94c2d9086e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd309cf7-7fac-43da-88f3-c18949d03c51", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "060ef067-5cf5-4217-b323-ac099efe5b9c", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c163e9-f82c-4bc5-b560-5e1f75940ea2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2db8dc3-d9ea-41b1-9e2f-d851ec969372", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", "links", "types", ":link_type_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "max_links" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "link_type_id", "description": "(Required) Contact Link type identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spouse\",\n \"max_links\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9d4ef13-bb7a-4cc2-981d-7ade7bd6ac7d", "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": "5f4671b3-2c46-4a63-9ef3-481d31ca7bf5", "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": "55e4138a-2976-439c-a9f7-152cf5c3bc47", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ef8640-d253-4ee1-befd-aefeb6520394", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a3df8d-4ab3-493c-acce-c4a4aa4a3934", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ad1fab-0269-43f3-b73b-4e24cdb7063d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45efb271-6787-41a1-8d41-ce4987e7ff7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0d7e850-ee19-4777-bd14-b4b89f9101e9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75cf0c17-9b4b-4c23-bd14-3b04699738a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f818cab4-d913-4001-803a-32e5ca3205a6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5359b97-1478-48d6-b3ed-784b36c749ac", "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": "7f0fe4df-9145-40bb-a8ff-6546199211d4", "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": "40833de1-e351-490d-ae5c-c8ea2cad8e2f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d55bf6-9e79-4b93-83e5-888087afe842", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0b074a-c316-42ab-9a59-009d45b961b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6983d346-853b-4c34-a6b4-b0faaea513c6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "616465c1-a11b-4531-be6c-797244d4bd94", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af9d73c-f2b2-4b11-aee1-729314740c79", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9900cd82-33ff-41e1-a842-0fa845f4dcb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72874675-8214-412c-a733-ca25a9c71026", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f155a09-1a0a-434b-9faa-f8b073b768dc", "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": "d460ef87-8150-47ee-9df3-1540ede565c4", "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": "4493ed61-bd26-4ecc-83ca-2df4dbe4aca7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa21bc96-189b-465d-a8d7-27b5e6ff860a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2818606f-1024-4648-b6ea-0014d125fcc4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b01bf94-b0e9-4995-a1cb-ae9b3e7df244", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a1406c-dae4-4f8a-b54c-83644a81902e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a87bba-d033-4fec-9ae4-513e59e346e1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71a42d54-b805-4e05-9e12-0ae241aa5442", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc8d07c9-1192-4d11-9b3a-70973d316bc5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa8a4d4b-a6e6-45ba-8d60-2a1ab65e34fe", "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": "926d1b0d-6c37-4f63-b9dd-cbae3d911204", "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": "b1ac9e1b-a598-404e-9a13-b9b45bfaa3e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81464161-493b-4f6a-ae08-f923e375ce94", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d477a88e-cd10-4154-bbf2-1ae9c11cf4d2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5589afac-7b6d-4d45-adc9-04d7d2dbed3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab4b546-eec6-4a78-83be-b2f52a53bbb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02bc8470-669c-4724-817a-9020267806f1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5800c6e5-6194-4c3d-af7a-18602fa89621", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd07d090-499a-4292-890d-811e928e50b1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcd6a61f-6e63-43c9-998d-10511b140eff", "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": "df068ec8-3989-4603-bc4b-602d198cfda8", "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": "898c5529-8049-47da-bd7e-d371e131de20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a59729e9-8144-4029-a868-fdb3f99db5d5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c74a7a-c5a3-4c89-aece-4cacfd314ea8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1b4e91b-674a-4da9-bd54-e45314358a1b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2018534-e10f-416e-b9d7-a6004c9fffee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f711a0f-86da-4132-b9d2-86f861a1a266", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a2b7ff0-00ef-41c9-afbd-cd2662366219", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bf92c92-7f92-4551-b90d-7b1238a10dfe", "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\": 5119,\n \"message\": \"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": "da4d5319-5bd9-4c8f-a316-c508c74a44ca", "name": "Email", "description": { "content": "Email endpoints.", "type": "text/plain" }, "item": [ { "id": "acfb2501-0814-409e-b998-ff3ca04cdf7e", "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": "13e96885-ae02-4ddb-816e-126dfffadf7a", "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": "778a58a5-e875-4519-a2f5-c96313ce0c00", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539c06d1-50f3-4d08-b608-7b0803397fa1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf2a0df0-98f9-4aef-902a-05917d6b23eb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "887cd442-387f-4dd4-93fc-10164e5e5c3f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e777465-1b99-40c4-b248-f77605b24535", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f139469d-a5f1-48d2-9dc3-5326a40a65bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8038dff-5e9c-4804-893b-944435440f4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dc48a7d-16f9-4416-a273-065522fd15d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38e1881f-b675-4dd8-91a6-fcfc26f4f9f3", "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": "8abbb55c-9a84-4495-a36c-335bbd51fe20", "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": "267548c0-c39c-4bff-9540-bb7b30749724", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7de9299-3c71-46c1-a8dc-5943bd4896a3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd353805-b63f-40d1-b6b8-981d30d3cd89", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e4351b6-c6c5-43a7-831f-72f3d57fe3c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1555f6d3-c569-4fb7-880d-74e9a87ba6bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0ab6431-837c-4b18-8234-f08e2412d6bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5aefbe8-e602-4043-a911-39b29b0dc472", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f98c8b51-943f-42a0-aed7-f0dcad1a8ba1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30819972-6f71-4496-8e0a-26b84aa4cc2e", "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": "d4c4ad95-2961-4520-8f8d-3c3b4566e89c", "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": "2f5242a1-0d76-4051-bf39-f5e9764103d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d58c94-a74c-4fe6-af12-0d9c85f86f80", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d1608d-98a1-4153-9960-72625d3e4cd8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba137433-5043-418c-93aa-57fa91ea9885", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07769d7f-91f0-4ef9-b45f-c5c3e1677973", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cd5b175-9722-46e4-b21c-c01d54fb74fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bcc32fd-0498-4b5c-b933-215a42a8257f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1602d768-7e0f-4ead-bf81-11ab9ebf27f3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98f5f0e3-076f-4be5-97f4-a8abc6adeb66", "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": "e1aa57bc-1108-4f68-b3b9-35152d666014", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "emails:batchRemove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_ids\": [\n \"123\",\n \"456\",\n \"789\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "290d8334-2900-4ad6-9641-f5fb04792508", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4307b140-317c-4573-8a7a-3b5af637f90d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95cf3db7-8fe5-48d7-a002-4de9d7ed1fb0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "125fd2cf-5950-4450-9b87-4f9da428f1f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc750964-efe4-416c-9e16-497b6c98c957", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efd5bd0f-61b1-4cc2-a728-151ab4eae644", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a55b5b6c-8889-4768-b817-a21d221446ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f4df309-5c78-4c23-848a-53b610c23329", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f7fc25c-4904-46d7-a638-eb4d47ce4ebc", "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": "a967ae3c-b0b5-412b-a10c-7204be1ee2fa", "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": "adfa4f28-74c0-4a6f-a0d6-d5bf7837fe16", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63c1cde1-b288-4ef4-9039-44d7c00847f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fff660e-3b68-4322-a8e0-042019e0f54d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b654fa1a-f5f1-49d2-8d3b-f8af4be1446c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93086889-6b7d-4e9d-b67b-b6c7fee750c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c8fefd8-c3cc-49ee-af65-bf81eef351b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d2e1e78-b77d-4cfc-8cb4-a158d9a1fb19", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28722f26-2fb6-4a1f-a52d-3216ca05d0a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "427b6ec4-6f1c-4db7-a177-15c0247a5ede", "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": "f35c8b89-aa20-4f2a-9dab-b785dfac5812", "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": "51906bc6-abc5-4d43-8825-7958a3e9abb3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6436741b-50f8-412c-9c58-a1c425660f3f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e88b7b3a-88eb-4ee2-bb74-3b3b2c4d8d64", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7b46c8-0dc3-4158-acd6-b540ad22694b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a657f008-4eae-45f4-b1f5-234556596ac2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4179f2a0-7a93-4846-8ac4-18b98903ead7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51154c88-91b4-48d8-8786-7ea7101c6c2a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7710d7b-a2c9-470c-9854-5a6cb21408dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc24d238-6177-4bd9-ba7d-21ac1d01308c", "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": "6deb7b71-260a-47fe-8a2e-3d49f69803f0", "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": "ec85a57d-c0cf-443c-ad10-0cba6f128d7b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01f4ea47-0544-4685-9741-8e17602c5cc4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dba2cf8a-73d0-424c-a9a9-b6e62313db72", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08dac035-ac91-4b5c-8270-9de90e7b1d6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adc7f248-13d7-46e8-b820-deb72e4e0e49", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08994ec-9024-4137-8017-59578d25c2ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf701935-b3f6-4278-a551-972566325c8f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ea23e40-f5f1-4e94-9f94-d121c36692e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b13c9ab3-734d-4ce1-993d-901ca12423c5", "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": "a7070969-bc4c-47cb-b5f2-28a41257a4c5", "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": "be4debe7-e3e5-473f-84c8-3fe696185b36", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87e9dd00-599e-4444-b9d0-f10d6f95a56d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bba2a6e-22c5-4567-8f7c-8a1ccb6f74b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f21e259b-f58a-4485-9797-07ae14751312", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37fe1cf8-6362-491c-bb40-1b744b6ee946", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7aa31a-af71-43fb-9c52-b8d75e1e2857", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2044cb12-4e6c-4121-9faa-11622fcff320", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "800cddea-fc48-4f25-b04f-dc806aeaf9cd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13f05f63-5807-4abc-8e1b-2c76bd3722d5", "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": "d996e959-a835-4b7b-9c41-8bcddd0a632f", "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": "ed9cf8fb-71c9-4f89-97ac-a612cbe811a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39afff0-ba3b-4f80-b95d-fbaa31e71984", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa1da082-faea-44a4-b016-9936900f583c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c813198-d355-4284-a371-254a0508b236", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1adfdd66-8395-4cf2-a232-efb8d57c5f30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf0df822-94b0-459f-b0aa-d22d2c7adbab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41da4c3b-b098-4c68-872c-136e80409f84", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67061fe9-5e6c-441a-8418-88364ee05769", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ef5aca5-aabc-4add-aeb1-62c6461c54a8", "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": "dc54d09c-9be2-407d-9a0d-76f06f2e56a0", "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\": 5377,\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": "2786d2bf-85cc-44f4-ad52-abc76f64ddae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8f64f64-6690-4fad-96ab-18c26daf6f90", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ba1b0a-f4f4-4a6c-8ff8-562095dafa3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "477c2377-e50f-4b62-8787-097030f47143", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bba4cfd-3147-48d9-88d5-ecf1eb0513a2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32a9d260-02b2-4258-a884-8b7291d938ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c5923a9-46f8-419a-a670-02abc0fd3621", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5787b74b-c56b-4303-a7c2-1e39db176bdb", "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\": 5119,\n \"message\": \"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": "a527f4df-fcd1-4903-b5c9-e71192c1481e", "name": "Email Address", "description": { "content": "Email Address endpoints.", "type": "text/plain" }, "item": [ { "id": "0bf25294-7221-4442-97dc-b24e0438e674", "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": "6d614809-014d-4a32-a8e4-580bc99c05d2", "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": "be44bb2b-4401-4091-950f-8743cbf305c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c67b779f-5468-4a80-a280-a62217433e5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b70a24c-e6cf-4ccf-b9bb-e4fb498242bb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3aa88b7-e13f-4f6f-b93c-e40cf7a93d7c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2129afeb-ef04-41df-b242-f08febe42e61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eca2269-dfa8-4dbe-9309-26cbc8d95f58", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87711fc1-adc5-4a7e-a004-90bd3e5c36c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1257418-d1ce-42e0-bdbc-3b9330b8f942", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "881a0fc0-3038-42eb-9640-778fddf30423", "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": "ccbf5e3f-165d-4625-8a0e-a345ecc7585e", "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": "82af651f-1719-4c15-a754-e689cc5ee3cc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d8f7e49-c7f9-42c6-a72a-0ca287070444", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f836123b-72e7-44ba-adaa-9695d97a9331", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0f7cb16-c09c-4af2-b94c-aafd2f20108d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b3fab86-49d3-4ebc-810d-d5052cc4bda3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04fa6c9f-939e-46f9-9494-37fa7d368e21", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db214fb0-2349-43d9-9525-97bc1fccc179", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d171fd06-7859-4083-9b6b-a8dff8ddf363", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc7d14fe-54e3-4dc8-8913-842b9931e696", "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": "d99f4be6-4a65-4c3d-bcc1-dc9e4f9995c1", "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": "6c26557a-c139-4f9d-a208-9fb8990f0b22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9f97c06-25e9-4e33-9798-3380a931b5ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f243ca-1dfd-45a0-b599-912f56b79f3c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bde46efb-3b17-43b5-8fb3-fae2fb7b7e1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9093fc3f-cc62-4487-90c6-ccb0d0f7bb17", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c7cbd9-797b-4052-97ca-5b022db07948", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d684c20d-7533-432c-9416-f24cb41c0b9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf062b82-238c-4a64-8cc5-ccc0e1f0b362", "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\": 5119,\n \"message\": \"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": "0826ab35-d5b9-4488-b656-1c2024c39219", "name": "Files", "description": { "content": "Files endpoints.", "type": "text/plain" }, "item": [ { "id": "2efbca54-f13f-4cd4-80ed-828b1e6b4b15", "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": "33b513bd-a159-4097-b7b8-96dcb7ebab7c", "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": "137b8d33-11eb-4819-b386-8bfc9896601a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c80df0-d6a5-44a8-9d00-c755696265e1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f8a9db-da9a-44d1-b0e7-a3d437ad051a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135af506-2cad-493c-9ea2-87f7ee7cc950", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c864dab5-04aa-4d49-b80c-3a36ece046c6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c855218-d9b1-40d9-8dc2-458be3e1c018", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ebf071-ae14-470d-91c3-8245fe5adba8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ef607e3-5c92-40e4-a144-645d39a2df56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e06257a-27a9-4647-8192-1057d189a91f", "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": "000ae591-42c9-478e-840c-950714b881be", "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": "83391d9c-fb4f-4a2f-b2ed-a6afe7dffe49", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c16539a6-4512-43ac-ab3b-3f4eb1487b63", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b23a0aa9-897b-4ffb-99e5-7fe76293138a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c8244cb-133b-4f35-af12-47551b63349f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e5c385d-7ef1-42b7-899b-b5462c33b9d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71f0146b-295e-4d39-96bc-a4eca194cfb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac1d4372-3bf7-45df-bcda-8af9d0fb8dd0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaab5a3c-4bb9-4ba7-b674-315bc0f441de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f325fc2d-1e5d-4036-9800-374b5cf7358d", "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": "c23e9854-0384-45b4-9f20-a6245630fbda", "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": "8d60657b-14a0-4a4c-955f-765b00f2004e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88123588-84be-40ac-a980-536f080436df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "199bb7bf-464a-44e9-8846-b3dce005d74d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce33eca-3d57-4150-8dbe-1d4e436f2691", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85cd008a-7b16-4509-addd-ab6e61ec2878", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0fa6bdf-a2e6-4695-9b79-de82ac56893c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab1c412-aaf2-4f0f-9729-1f6e93c5a439", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d47e438-6889-47b5-9e51-cd28f29aad1e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e42b92c6-d612-4175-8790-9acd9e717077", "name": "Update a file", "request": { "name": "Update a file", "description": { "content": "Updates a file using multipart/form-data. Note that this endpoint uses POST instead of PATCH.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "file_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "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." } ], "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": "47cd6d09-a0d4-4465-a57b-581ce9c7885a", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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": "e24ea721-3a62-49bb-9b06-7520193b952d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba8fc37e-4771-4608-bf6a-962ebe5ce7ad", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee7cbff-fe1f-48ed-b099-32e5d63fe27e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a699dc66-c8df-40a4-85e6-fcf0ca4f017a", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9249188e-874d-45c2-a729-af213b0fbe00", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b490475-1d33-478a-816d-25a408c3b8c1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c70d99c-aca5-48ab-8b33-9cef966becea", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45677751-365d-4553-a8f8-ba9f9826131c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "files", ":file_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "is_public" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1494ffc9-7ba3-4203-bde6-b631d9ca7f52", "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": "052715e1-afbf-495d-b4b6-c9d0413009f3", "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": "4d631f75-a963-4a07-b9bb-835124554a6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb508140-76bb-4d4b-ab90-bee5773aca56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db76daf5-f714-45e2-9793-994ece51772b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe8f1d3-021d-4207-a201-25a1014f798e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326f3819-2624-4f20-bc33-8d7cf0e1d077", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78e77631-f6bb-40ca-9319-73aaaa51104c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7df6488-b764-4035-9513-ff3b3be36152", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "028de4c9-a355-4ffd-a1f3-a394198c5a57", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dd1ef08-67d7-4b3e-a051-76c9e823c229", "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": "e0d9add8-ba9b-4eaf-b546-917f59eb7572", "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": "749656d9-5c33-4cfb-a176-f4ebe525a050", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8e0e36-5e79-4456-827f-e2cb6b367adf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc48a987-7c6e-439f-8773-eed3fcb88a63", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1881965b-59bd-411b-b14e-fc6ccc62bc28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0675e7b7-94cb-40db-b14b-05db5766fd5a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f4aad8-7cd2-4492-8f84-313c12a552a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a2bf6c9-9f63-485d-8ae6-86566f8c7fb9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34378de-1e71-4942-9bd6-aee8f72fa8ed", "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\": 5119,\n \"message\": \"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": "2ef704c4-0466-4cc7-b0dc-6b143f9fcd07", "name": "Free Trial Discounts", "description": { "content": "Free Trial Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "164a40dd-516a-4e8a-814b-4343d87d5e0c", "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": "39343dbc-544e-4f63-b806-a4f18d8945c8", "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": "74efd8c9-555f-4f2f-b853-3420d32fc099", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc346ec8-78eb-45d4-a3fb-20a26df860e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3928644b-140c-4510-ba4a-54e7cadc2460", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a3b206-7e43-42ff-aeed-701d2e250043", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "148168c9-5c9b-4889-8905-f4d7dfb62d5b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7f3c95-9673-4b93-a0a4-727ce045ce61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1e74cfa-cfa2-43b8-9b9c-4b035c934fbe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e0f2051-864b-419d-ac58-6ca4d5ed56f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcf7e666-36c7-4b74-b6ee-01656126207b", "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": "540d4357-4014-4daf-9da5-2c061bf28d9e", "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": "c77685ed-93dd-4b88-b606-c371c38d51fe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06010ab7-3419-41f3-b3cb-334e26fc66b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b21ab2a-7e63-49b2-8a95-d26ea0b6238c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42b70d4c-dd91-43c0-a36b-32788ee41747", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf15e153-9eab-446f-91b6-3b472d544df7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e476be0b-bacd-4101-a7d7-b87a14d4f240", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222ccaa8-4f39-417a-8caa-72a1ea00239a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4910e840-b843-4dd2-8b79-3da595444391", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "298b69d0-d6cd-402e-8571-507b5630d295", "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": "ddf0c7bc-0664-4e46-bf5b-aec420beebf0", "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": "bf7e5871-b713-4ff6-b5bf-f730a407d411", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4869d5e0-640e-428f-88f2-8a5e7bdd664a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fda0f03-b47e-4493-9287-ffef68807064", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be5eeee-8d50-4b0a-bb64-885cedbe6c79", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671710f5-eb34-46e3-bc20-aaf43128fa90", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06a30b27-6911-43cf-8532-ca360ab40f2d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "878e5a8f-8496-44e0-967b-cae1ad3499a6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ae2d6a1-d7cb-4a17-ab8f-6360089957d2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c068563-f3db-43e5-b07c-e6228a9b31d1", "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": "fa8d446e-42e6-4f86-a96d-eda489fec0da", "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": "930cb60e-81db-46d4-8b79-873d57cc6506", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca374f22-fd88-4ace-9d5d-e874aa3fea8d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "286653be-b1e9-47fb-bd9e-2802048ffde0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac652d0d-f7ad-442f-b01f-e405b7348d3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdecb3a3-e024-42b4-9763-9754a28a6c6d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8cea96f-5bbb-4f29-9d58-99041fd56f21", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b81f5c92-7210-4e34-a761-1bfef3e37a53", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fd44297-5d8d-4273-a537-60599d88a83a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d9b7569-f5af-4585-a5e4-e67ff95d8cdf", "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": "1f72509a-4273-4a0e-9311-e7082ea6a35f", "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": "187a6359-ec24-41bd-aed4-fd5c398ebe04", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e7a87a-e3ec-473a-8fa5-1f006069d9f4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beddb60c-b07e-4994-9f2e-1b69515bbaf8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "546c016a-edc2-4b71-bbd9-e91ad197a356", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e48fbbd0-53f4-43bb-be7c-985bd9e1eaaf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a831450-cb3e-49dc-8fe5-b136883fd666", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c4d665f-6681-4066-8635-966408087d80", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4724a2b8-3bad-4c4f-ae01-55d836cf277a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec549122-853a-40c9-9e03-03114d95badf", "name": "Update a Subscription Free Trial Discount", "request": { "name": "Update a Subscription Free Trial Discount", "description": { "content": "Updates a Subscription Free Trial Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "hide_price", "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": "2b25e5f6-5843-4a74-8584-ab28d04ccb1e", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\",\n \"free_trial_days\": 30\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001a4f66-7abf-4738-83fc-eeff7e8dc9b7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e19253c-a876-44a7-8154-fadf466603f6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d197567-2035-4e4b-90f9-afbf6b74c71e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45d23b7f-e684-4fdc-ac9a-842a7315b968", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c867517-e254-4a6a-9e44-3ec3baf00d10", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3105713-227d-45fb-aa19-8784ea55debe", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70488bf1-922d-4696-a5de-36b3daa1725f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597d0b0b-857b-439c-ae50-9f822768bc69", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "freeTrials", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "criteria" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"30-Day Free Trial\",\n \"description\": \"Try our premium plan free for 30 days\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"free_trial_days\": 30,\n \"hide_price\": true,\n \"subscription_plan_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7a04c4e-303f-4883-b262-e0b8e1065aac", "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": "3d05c9a0-0432-46b4-b181-e426334c193d", "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": "3fcf79aa-e741-4e43-8a3e-95d9c2f2cd7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44eaffb5-680b-46c7-b4ce-765d1674ad6a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea4d98f-780c-4a58-a1e1-3372c485f1ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d77b042-a59a-449d-a7f3-3e1958da4d6f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33c851fa-ba37-4d8a-ae65-35adf281cd93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6069949-b4d5-4a40-b666-30060f98d256", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53dcf31-ae9e-4e51-8235-c5078218f853", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2e08a5d-a69f-420b-b87e-40cddfcb2018", "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\": 5119,\n \"message\": \"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": "a3e57155-e284-4fc5-92e8-14a9619c08f0", "name": "Integrations", "description": { "content": "Integrations endpoints.", "type": "text/plain" }, "item": [ { "id": "e3b89b7b-0573-4553-b49c-fc7b96a1f7d3", "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": "2ce6fcf0-0cc6-4d77-9281-88be1c308f74", "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": "4c403da1-50df-4186-b863-dbb5ebff133f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76842149-063e-4cfc-8af8-9f18e8c8221a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2606dcf8-e426-484b-9f5e-22cb3b18d495", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b95864a-7d09-4568-addd-15ca730604e3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27de14f2-f1cd-4709-bf5c-10fa041280b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13d32b29-8eac-419b-b581-2564f10cb146", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ea72c6-a25c-4995-88a4-3b3bab54cf0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfbe6f35-17e2-4198-8ae1-4877b354479c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a229cfd0-c43e-4ee2-84b7-0a9c27fff758", "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": "bba58d1b-24ee-48fc-82f9-ed45456cff08", "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": "06e9b570-3a03-4fe5-93c7-1ddb0e35c80e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd7ec4d5-0ba7-4c13-8542-be3cc4e9d45e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70fbbe9f-fd18-4d5d-954c-f3b4de65c3e8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7c7367d-4df2-4c10-9009-54c349cb908d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab67bd1-c146-4038-a986-beb04b3440a7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95c9e32e-ef07-4d65-83ba-77ab7290f1ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2056d48f-1a03-429e-967e-609ed30a4151", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "356bb042-35a9-4dbc-9f6b-49aad8dafd52", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31e1107e-c715-46ba-af33-0aaa80193eea", "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": "4dcb7a0e-f861-49ed-92cd-1b4d70fb3348", "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49c4a697-b81f-4792-b99e-b54987a27234", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb3a03a-b7ce-4923-866a-cfe2cc3efe0e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95116aa2-5bda-4810-a8ac-3092964ee0d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f59160a-087b-49c4-97ad-41cfd11f95ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7737ca8f-75a6-4f9c-aed3-66ed4231cbb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec862b04-d4ca-48b2-a895-1ba4da122ecd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d685623-bbee-4af0-b1ea-a77cbbd2480e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d7e7a5-5f97-487f-9117-f59abe4273c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec29ff7b-b841-4d11-b8ab-190c36ec2931", "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": "9a956f6a-dd51-4e6c-b233-6052f864405c", "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": "472a8365-f38d-4788-abe4-47d238935861", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49fb07c-8020-42ba-b93a-ab472cdf9e5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dd743b4-e51b-47ce-bef9-b549ffd6c801", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5461fa92-1ecc-4ba4-bcd6-e12186d9333c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1289a7d6-61f5-4c41-ad15-5f5e5e125da5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc04de5-9408-451f-a1ab-e81c131a4f56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca16d8b0-f475-4f9f-9710-e167428039ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb56e697-1e49-407d-a51d-061e49102852", "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\": 5119,\n \"message\": \"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": "ba778c6b-3755-47ee-b4b1-b0cdd8ef881b", "name": "Lead Source Categories", "description": { "content": "Lead Source Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "2505c940-488b-4eac-bc35-ea098485d482", "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": "3beb5c59-8adb-4929-8c9f-072d1b6297b2", "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": "9e258950-0141-4547-9c02-9bb782e1bb8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888c5345-c3a6-41af-b885-e126253a9263", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c45681-1bbf-4b49-88f8-f6d97b0ab72b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "535f5a15-44d1-4e9d-a98a-c8aa7b6d71fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9368d22-42ad-4b82-86d6-b9b8fd081167", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56de2575-3bbc-4b2f-9b12-fe92b5c05a92", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c818235-d655-4381-aae5-55f02d2fbed1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc6cdfb-f31d-4d33-a10b-d57b1df55320", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b5e0c7b-1d23-4f9a-b4bd-13294fdde304", "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": "9b8298da-5d3b-4e7c-bdc0-62807dcf68b4", "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": "5e9fb28b-482f-4966-bd3c-8def178e63c6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c203fa0-c02d-41b0-b569-4772ae4f4258", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f36179a-b307-4c45-9210-89ca5321a8e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd3590e-7e70-472a-b572-80e85e003df8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "753b74a9-41e8-4162-b29a-e955f051f3b8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93ba903-b732-47e3-925c-fc9ba3995b85", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c30e3aac-a32e-4650-a9c5-d7526f761918", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cf4804-6d24-4620-bafd-016b074c9503", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "484adcf1-fb93-4c96-beca-7da089baf302", "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": "666feb10-0530-43b3-899d-02a1086131fd", "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": "9daeb117-a377-4774-9f1d-cb67f167dc02", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af76ca44-0fda-4f48-b819-7e7c665c1216", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ea6b2b-0531-4d5b-835f-e5163885f7aa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "948b020e-7baa-4028-80ae-e983ab3aa1ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab732510-8e2f-4943-97ee-6ccdded9cede", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322f6d7d-8ee4-4f8c-8b3a-1c30712eca6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffcdb843-34d5-4d5b-ae67-bca68f9287b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aacd64e-8cf9-4a54-8cf8-2ed866e64145", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5010fdf3-9bc0-4483-8a38-41da15fc0a67", "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": "31a3f917-1020-42e2-8fcd-e5819d031bdf", "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": "a58fc1a3-1882-447f-ac81-c37aef4de22d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6168a27-b94f-4ae4-9f76-7d8dc06e3744", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb7a8dee-5ca6-422a-a74d-df421dde7f97", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1fa91e2-151e-4b5f-8825-b5761d960333", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67850e20-79f2-433b-bd21-405c3afa9b25", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06774682-ca2a-4857-9c68-261a68971caf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "180a9473-b2bb-49d4-b03f-4b32d9dda61d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b327db97-49c4-42e7-a7e0-14cd4b51f64d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71079dac-b27d-4989-910b-3ba81d427436", "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": "2cd0dff8-3720-4d7a-a300-ebdc69ac1e6f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6113c988-00a9-4997-9a02-3685a8010073", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a2a1c7-72dc-4e4e-85e4-4035fcefc028", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08e732f-b8de-4c7d-8e3a-cf212ee9075b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94437c87-02fd-4e3e-a9f2-d0607ee94112", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2efdf167-e171-412d-8270-930bde8d2a3b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc3e2f28-8f1c-4303-b0ca-903c702be523", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd8b9a6-9b39-4828-80e9-59094b336fa2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d06e5ef-a548-4cc7-ac77-83deaa3add89", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSourceCategories", ":lead_source_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_category_id", "description": "(Required) The ID of a lead source category" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Paid Advertising\",\n \"description\": \"All paid marketing channels\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"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": "ef29c7a6-f531-4047-9a2e-c48d94467950", "name": "Lead Source Expenses", "description": { "content": "Lead Source Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "5bbfdb73-d0eb-4b04-8e6c-6f8c57eabb99", "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": "59e5ec1b-b4a2-4cfe-af11-bf747cc3e46c", "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": "2bac30ef-3875-478d-95d4-26cb836a60c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfb6e69-91c5-4f9a-9b1b-0d097692a708", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ce3811-a02c-4aed-9211-8e083ca4b309", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe163e4-f744-4f57-a1ce-16b59c6bd554", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a5f889-4c65-4026-b8d6-842a2b9ea43f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3faa68c6-7fe8-4b5e-8728-8747f068d3b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105afc0e-63cd-4b7a-a30d-d45101af218d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a7c64fe-a321-44dd-84a6-f5461e9bee73", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19895cba-46f0-4115-8c50-096eb95adaef", "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": "81c1b7ac-48f4-4456-a9c2-2639c4f59820", "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": "8cebb120-b4bd-4004-86e5-226c89d25bd5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59d78875-de06-44ed-8ad6-a21f83dc9d60", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c450b0c-f7cf-4d39-987c-bcf636d206b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c23ced-a948-42d4-814b-cd8d1af83351", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c9e0647-9b76-4caa-a1dd-1f17d10cd40b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d81de5ab-8e01-403d-9516-c4ce8f9e7f3d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0574513-04c3-4d59-b287-8757c6366126", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b990fcf1-9990-42e9-90bc-4e1c6874fb8b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dec4af7-7d9e-45ca-a647-97db85fc8644", "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": "1a814594-6b8d-46f4-9867-17c420c1f75b", "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": "915bbe4f-36e7-460d-9d3b-6fc3e0f90d5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba6e916b-1369-4b62-83e1-0179861a0efd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79f35a83-aba0-444a-84e9-42e0f6ab4844", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db87dfd4-1f7d-41ec-bfa2-091dfba390ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3aa1c70-2a96-4a60-8fef-1c241ace3440", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b89d274f-2d24-4b07-9b52-def0b391cfa9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9b6212-a89b-41e0-b6a6-4b99e171f662", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c00004ec-77dd-4c47-a386-33ad4376031c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41978930-79da-4b4f-9b1d-7309e84bc712", "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": "2f9c08ab-187c-400f-907c-169dc9eca409", "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": "1e6a7677-c399-47cf-9058-f6a11675a831", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7b3e4f2-87ba-4d6e-ae66-c765247fefc7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9934cba5-66a4-49b8-a806-42bc13de439a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f29d29a-5299-4fea-a3c5-8032760301b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a724fc8-fff4-4f1d-9a46-fbc6dbc204c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4f06ab3-ab11-49eb-82e1-0b28a4119698", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3255280-dd3b-40b8-9b61-5cc1e4190232", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485fd387-1265-49bd-9c9f-dba937f0aaed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c6f7536-8a12-47dc-bd4f-d2488ae7e0a9", "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": "title", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "notes", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this 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": "5f8676f1-d7cc-43b6-b136-60b8466911f1", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"lead_source_id\": \"string\",\n \"lead_source_recurring_expense_id\": \"string\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\",\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b85097-4aaf-401e-87ba-704fc5ef2c9b", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6ecb45-08b5-4f7a-9f16-b2a78bc6ad37", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a0f81e3-1e40-4c81-b824-df7c053bd44f", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb36efec-ecb3-430c-8fa2-7d28c3b2f3bc", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc56128e-2ed2-4a7c-8860-a32be0bb27ba", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70248826-6fc6-4f3a-9fdb-6d3046694af3", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c780bb-18be-4f1e-ab9d-26bfa442808c", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a03f8d9e-2a95-46e8-b131-b744b4cd1018", "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": "amount" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "lead_source_id", "description": "(Required) The ID of the lead source this expense belongs to" }, { "disabled": false, "type": "any", "value": "string", "key": "lead_source_expense_id", "description": "(Required) The ID of a lead source expense" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Google Ads Campaign\",\n \"notes\": \"Q1 advertising spend\",\n \"amount\": 22550,\n \"incurred_time\": \"2024-03-15T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"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": "1986d2f3-f3ff-4395-bfb8-35b9985848b0", "name": "Lead Source Recurring Expenses", "description": { "content": "Lead Source Recurring Expenses endpoints.", "type": "text/plain" }, "item": [ { "id": "9a6892b6-b896-4e87-955a-4ce8a141394e", "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": "9d255ebb-d791-4bc0-8a8d-47460bf3090b", "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": "6ac8e616-fcb7-4351-b7c3-bb701f9bf104", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9698d9b-fa93-4c1e-a516-9e9c7826781c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24fa3d35-f0ed-495a-9a3a-cb840bbc6df5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "783771f3-6c46-4573-aa9e-15068041db22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2540c3-a6be-4476-baea-d57f9d1f2bc8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6af6c37-842a-4e50-8929-0bde9c80962a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255bd642-b996-4869-b0c7-bdcfe24605b5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51c3c22d-026a-417d-ab8a-7a0bc2cda948", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ec1b5cf-d844-4f13-827f-50c8b889697e", "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": "400a6f23-7738-4f3d-9a20-67e078798272", "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": "354d5017-2e5e-45de-b28d-2a3b6c523246", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2086198-1e08-4751-b669-c191b651fcef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7243aca-3c76-4767-9664-e2d6840e1e62", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c23eeff2-5f4a-44ae-927e-2d3ed18f29ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e859a5-e674-4ae7-b96d-d2b3f25175d2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a78688-1b73-4cc1-aa18-2cdef9371633", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22c43ae-127a-49a4-8a94-e44691584b1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4559ab5-4244-4220-bff4-a952849648e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5417fbd6-9628-4b12-91f4-131b89aeee27", "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": "faabe241-1b66-40c5-bd85-9a44a662baf1", "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": "4ebb8778-5d10-428e-a742-39a4f48ad50c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "397d489d-356e-4d08-a37a-7f89a7111e17", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "195f148a-2a7e-4a5f-8c03-241d53ea83b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e7dd4a-659f-485f-ab2d-4765a4408dad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b19d1b5-4c50-41f9-8373-2b2b531302ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba9f5fd-de59-48f9-9b28-cfe6d4e2b09c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b197dd-f7a3-4960-b60d-47c584014de2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "247c240a-ef40-4b0e-a5af-5c3cf538fe0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "548c7c7b-b291-45d5-ae85-8848f718463f", "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": "a1c1d19d-6b86-4537-8c8c-8362dd7e9f0e", "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": "28ad61ca-d4be-42fb-a84b-b0ac00eaf292", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bd7626a-bccd-42b8-9d2a-cbe597fa77d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09923096-def9-49b5-96f1-296c15c5f787", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca5f213-8fee-42d6-95a8-9d0b6499cd38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8afb475-1fc5-4baf-b504-c9de2c9eea94", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e8c619c-22d5-4c1e-a0a9-f431ff7d7644", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b2911c9-21dd-4506-a137-991bd31f7ff2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c0d9bb-289f-40b2-8ad4-00890975df44", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3038941f-5141-4c7f-8d5d-1ea540b7a2e3", "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": "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." }, { "disabled": false, "key": "update_mask", "value": "start_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "02fe87f6-cf2d-47d3-8160-ab23fb27f242", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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": "32b17467-c7b4-4355-87f0-a32b4f738d95", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45109e67-2c5e-4a6a-aa77-2d56be6eaf11", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210e21b1-11c3-403f-9abe-de843e97fa5a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd5d82f-bbd7-41f5-81a5-a95fdeaa6490", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ea3cef5-690c-4186-841d-9eb7ea48b276", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff4e954b-d682-4074-b6b3-47b74e84ecdd", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba134e5-6896-4dfe-86b1-f2b5f1a97181", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9d5dd3-54c0-4673-9640-b34ab795558b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id", "recurringExpenses", ":lead_source_recurring_expense_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "end_time" }, { "key": "update_mask", "value": "notes" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2223f4b-392f-4132-8296-9dbdd0dc3745", "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": "92e2d2f2-0350-46c3-966a-1f54f7142c74", "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": "f34893b8-7813-40fa-af2f-f5e26190fd68", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48788dc1-1d58-4a7a-a8a6-86aad2c86a9e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93527826-7be9-430a-b1c0-e49e530dd02b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98fd65ca-310c-4853-b6a2-32af0cf7206a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4e44b6-c903-45b4-9c78-2cbec0ed170b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed678b29-1f49-4434-a0f6-c43f9e55a188", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f7c3f5b-c890-45c2-b064-94ceef008778", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aead70c8-e32f-4d94-b701-0db551b47062", "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\": 5119,\n \"message\": \"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": "ac593bb9-87cd-448b-a8ef-16bc473459ae", "name": "Lead Sources", "description": { "content": "Lead Sources endpoints.", "type": "text/plain" }, "item": [ { "id": "b77d1894-f812-4a9d-9aa9-d4c25eab8bd8", "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": "d8011bdf-639c-4a13-819e-0cb1c717cd8d", "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": "9c5621cd-7e04-481e-88b2-259e799ea25c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcabf860-a3a0-45cd-afd8-01b21f139dc7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dba633b-5020-4238-9343-7fb35ad1eda7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a6e864-6253-40e1-99dd-7ecaada1ed22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e860f051-d692-436f-ab36-b20b121cdb40", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a737501-d479-4584-8d87-ba52c3782678", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b8d556-9606-43e1-9e85-8b91aaf688dd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d01259e-19e7-4d3d-b9f2-1d5086907bdf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e684056-4525-42ed-b562-186a654097b9", "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": "aa23764d-896a-46a5-8679-bdbc43edc8ca", "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": "2dafb262-87c8-4c64-b80b-98fe7f4af8f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f48c77-ea18-4777-88f5-7b3749dd3c1c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c5ae7c6-3698-4f6f-8865-42e1e004296a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a737e6-eaba-4947-9422-bcd607126a99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a075682-9584-45f8-b034-c1da1ced819a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0505e3bf-e206-427a-81f9-e001f638ca51", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76cb04a2-094b-4c9b-955b-50806f72d9e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a21a97-f38b-4513-8bbb-64c0f834aaa1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfd4c7cd-69fa-4499-87ac-c53d29038654", "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": "6d184f7a-ae7f-42de-a7f6-9f20acea080f", "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": "471681eb-72d4-4a2d-98d6-b4a818cc64ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f4d803-f30a-4fc0-89c3-61a576a62535", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dde749b-1001-4ab0-acaa-1ca7bc071a79", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d80855e1-e3e0-4b0a-89b3-33ea2c1a6a06", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac672123-19eb-4724-a406-7c104d2f55b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa9671c6-348c-459c-9393-2da8c4866bd3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b68a93a2-911e-40f8-aafa-94f6b74ee73f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7147a78b-3294-463e-9ee7-565438932bc1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6831466-1bdf-4405-abaa-5c35f12660e6", "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": "b074497f-7f8b-4b3c-8c59-b8af63fe38b9", "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": "c753b504-490a-49f4-8483-c1c18b02918a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959b0781-decc-4614-9518-159563b57a93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b062df3c-8f76-45ab-bd9a-c8e912f80960", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ec5022-b0df-4f6e-a7ea-d520658573ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21db4fbd-403d-4b0b-b7c4-d83485c5fd22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fcd8b16-d9e8-4cf7-881b-92b0b4676f67", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c4886fa-7d24-492a-85c6-0555d1220332", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ff5351-8827-44ab-878b-7acb7187718b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92129ccf-4139-4b33-8964-36d3a36f6a13", "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": "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": "status", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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": "a3aeda15-49cc-4eef-a8ef-9ca2f1f3d4dc", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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": "4b3032a8-bf77-4eea-9fc9-bf8fa0c81aa4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee7ab8d9-c84f-40dd-a2f9-7ec3bc72ca3b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "106e049a-aca3-4446-85c5-42dda68b63ba", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3181b232-425c-42f1-9e1c-93f0859f2cf0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76b46ba7-e5c6-4699-84c9-c999715ed158", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc7cf8ef-4fd2-4bef-9855-ae9186edb8b7", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de303c4-23b4-4abd-892f-b5a6640296c8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "493c73e1-ee2d-42e1-a51c-794ed9e33560", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "leadSources", ":lead_source_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "message" }, { "key": "update_mask", "value": "lead_source_category_id" } ], "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\": 5119,\n \"message\": \"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": "3b7ab7f9-c82e-4c76-a127-2a2b65c316e2", "name": "LeadScore", "description": { "content": "LeadScore endpoints.", "type": "text/plain" }, "item": [ { "id": "d8724ac4-d6f1-48b5-a9ac-af3e36ee52cf", "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": "4c5a5be5-28b9-4ece-bdaa-90785d81bd3e", "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": "71c218b1-77de-4dac-ad78-d545963190a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "291a1e6b-3585-40a0-a450-5b0919288999", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a08ef32-1da7-4555-a2a7-56dc5f7304d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af4bddf2-34d6-493e-bf8f-a29a945ca16e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f16d1756-647c-4958-9c83-56302dd6987a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b5eeee9-68ea-41df-9476-30593000a604", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c91d737a-99d6-4de7-8b3c-2968ee9abab9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fc121a1-f428-4476-963e-172113bf3cfb", "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\": 5119,\n \"message\": \"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": "f1b94d01-e2f7-49f3-ab31-3fdfeeb9772b", "name": "Locale", "description": { "content": "Locale endpoints.", "type": "text/plain" }, "item": [ { "id": "83fa961f-e334-4e0f-ab7d-d7cbcd3a6d1c", "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": "f637393c-8eb7-43ee-9ad6-809852a0a6db", "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": "1f2461ea-f99d-4898-bdc0-7863e70782fd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e2d00e-6645-40f4-991e-b33bbc17d4c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aa5a4a2-6219-4190-a454-bdad21935783", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7d45054-d43b-4fb1-a83c-0147e0e43846", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b036f40-f3dc-4bfe-8dd8-74c2bfa89698", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ced1970-3629-4020-94ec-811dc9bdbb8d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21f3de97-b2c3-4470-b2e2-98c0073e6ea9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d1c112-b0e1-4627-b4c7-6acdd71348cc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfdb48c2-c3d6-4510-a745-6eaa8cad93c5", "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": "d5dba67a-a82c-4b14-9443-fa296bd14192", "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": "eb2cb6d0-89da-4d49-99ee-5167253d5a58", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72471d51-8461-4928-afc4-27f5d0784e4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d4266df-d917-4a59-9fb8-9103b68f49a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "875c6e80-3ac0-45df-bb63-3597fba33328", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1387beb7-b63d-495a-90a5-c58b455d66c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b20f17-f59e-4ade-b238-4b72e8d56211", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a76ca6-108f-47fa-ab34-fe51a2af2aa3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d54f155f-7aed-4ced-976b-9e1a9fc5918f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bbf97c02-bb81-4be7-8e2e-bae0a7d7e8bb", "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": "e074eb21-f698-4ce3-b34c-801476fb0b0b", "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": "7390be1e-3232-42d4-b064-9a9cc5ca0f65", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d937e59-3940-4c47-a431-694c126fe6c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f009e4d-6a81-42eb-95da-f7904f408039", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2156aad-1c22-46d3-ba38-93ec5af4984b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "373546d7-09c3-49e4-b15a-ce8ac701d6e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfacde6e-414b-482d-b288-b01955d0e2ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e98fc360-ed01-47b2-87d6-0521ec7cdf9a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9788ef9-977d-4d85-a5e6-e85d4f9e671b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "237a19f5-5b5d-48ad-ba7a-82eba24d52f9", "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": "9ca36125-23de-4316-b307-9e9a94a649a1", "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": "4966fbee-cc75-4c6c-a592-a6a7ebed29f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "461e9b2b-579e-4c63-8141-a638f0956dd1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5209676a-be50-416c-afa4-99ac36136f7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a4a65c-81db-4a2d-846e-e610e634fa4d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08696e5d-2d2a-44f6-90cc-d784c4c49958", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d58d404d-696a-4010-8fdc-9ab430f29eb2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a9f48eb-a77d-4a84-a03e-751c0e3ba4c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "626ccde2-aa8e-4061-a133-141af2eec1f0", "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\": 5119,\n \"message\": \"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": "8cb2e3c2-54b7-411b-a70a-02648405a37b", "name": "Merchants", "description": { "content": "Merchants endpoints.", "type": "text/plain" }, "item": [ { "id": "8d40012d-821e-4531-b3a7-dcafb29640a7", "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": "32288d4c-81dd-4673-8ba6-c430ac34c0c2", "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": "b8daf3f1-db81-4566-8f66-7fb6f908d0c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a76fe281-60e6-445f-8403-8ea354731033", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "363c1527-3ab3-4fd9-a550-a836f5cd2251", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc7063b-3090-4084-ba72-ae407b31081e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e21cd62f-8523-459c-8f08-d2704d49f90d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6a7539-ba69-4161-bf7c-23d9a56245e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c2179b-3570-463e-9c75-ba5a410beaa1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad27c739-1371-49e6-a765-896fd2a0e766", "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\": 5119,\n \"message\": \"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": "0c5adcc9-b41b-49e7-bf34-a4250c773605", "name": "Note", "description": { "content": "Note endpoints.", "type": "text/plain" }, "item": [ { "id": "431604f0-3b89-4d27-933b-2ff94734ea27", "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\": \"PERCENT\",\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": "27d8228a-120f-45bd-94c4-d2dec142bc09", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85fe0063-d080-4134-ad72-7ea2a6f9942a", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eae9cdbe-7099-476c-9c76-12157669c1c2", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98b12ea-572e-4b5a-a86c-df3ca2a47a62", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ab45bf8-c245-4d43-bfee-2e368f542a8c", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e5bf44-804c-4cb2-bddd-b926d0efc965", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b775c52d-a962-45df-858f-e93073c49328", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cce9ae6b-efe3-48db-89e5-527688074bb6", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec73514-c6b5-48ca-8a7d-b81d07579433", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb885bbd-0d92-46a2-a34c-4c72113801f5", "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": "a69ff14b-cc0c-4003-bb48-db6412b777ca", "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": "fda45a03-a067-4b46-80a7-dbb93cc3e1da", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3def7a-7ca8-460a-9fc1-f54d10b909e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "101fa2d9-5a33-4011-8585-2a0a75d97697", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "411acb35-385b-4ec3-ac38-e2dfb6296c15", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91681768-73f6-4859-b075-8c30252020dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc655c64-97b3-4114-ac12-a3f8b8d32472", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95625171-6a9a-4349-b565-ca1d0411e343", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690945a4-052f-49ef-a45c-f759b8c991e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0575545-38b4-4ee4-babc-91b411510182", "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": "0e6fc0a8-291b-4536-a5d7-9f55bdd4e322", "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": "6b761cef-8ce2-4b0f-8099-7c3a2d727de7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc4d48a0-fec8-4080-a1b4-4cfec76b3f88", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efe5cc93-6dc3-4c65-8041-1f6ccafcaf39", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "616aa85f-d025-46c5-b342-2f25abfc562d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c025cd-eaf3-4ca3-a44a-581669c09a24", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e1b2df7-b159-4893-8b96-da199acd5419", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e4ffb07-3144-4d91-bbcd-83166b2b5987", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a14f90c3-4e6f-4e0c-a865-63bd5e4e7c8a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3be30acd-34b0-46b2-b9ba-7179d6f1d0ae", "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": "3f582516-fee5-4ecc-9d13-a58d79ba8fb4", "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": "21453dc2-a801-4866-8cc7-e798bd2ea360", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06983833-6b05-43e5-b441-ac861c69acaa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49f6bc64-5323-4b65-86f8-8fb061aae0d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02e0547f-06b9-4e64-80fb-d71043c5c828", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1139471-a1bb-46fd-9058-e8ab8b4cb8b8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee55b076-bea0-423a-8a5e-5f8f0f44ed13", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "413b68fb-bbc5-4d2e-857c-95aedc34d153", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee126a6-a5e4-4332-b0e9-861b14aa36ff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc30223f-6857-4d04-b168-3faeda6b4864", "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": "184e2798-87d4-49f9-8626-9b307a930131", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a2d9022-e4ce-41b0-8da0-3c738275ec2c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a69459d4-728e-4e67-bb4b-70dfc138d65c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "797e178d-073b-4ba0-87df-35e8b133a995", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0ad50a-23f6-448b-8da4-5faef03053e1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b1f6cc-53a8-4696-a47a-e26efa10831d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a708d43-b688-40d9-b843-0207b60319f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db8a05b7-c030-4f01-bef4-fb35b39101b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cebe84b4-83a7-4e63-9019-9fb7936e639e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "256ed4a7-b065-4b4d-b285-c9c5076e3f7c", "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": "a4490d25-d0d5-443d-8796-3e3f371c35e0", "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": "c60b8c11-f1fc-4bb6-9dd9-2c05def1c6d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1227f98-f90c-4328-adac-97aa168e2289", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d01ef46-6d78-4e7a-8e5a-0257acd2ad5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3e11038-b7c8-4dac-80c8-7a41cc2fe280", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e85a81c4-0ad7-4c3c-bc32-bb83ff7bd6f1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876d7dd5-bfd5-45b1-8b2f-19a1ee335f33", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af0ad89-21e6-4f59-b8ae-52aeb9b53e64", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac0c926f-f6f2-41f1-9094-ed56c50f2017", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a511cf9a-2b06-44a0-a91c-f49b48cd0255", "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": "d99a7bdf-d037-443a-9f8d-b49aedf2aa41", "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": "f4db8d46-2f20-4f15-9aad-ba4dae20aa42", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5f8daf7-eca0-490c-9688-32e5745ebbd4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91c33197-81f6-413a-b4b0-f73d183073e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c690e07-1218-4a9c-bc83-3442970d9850", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "381bd278-dc8c-4697-a021-0d0bfa40a632", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c9058c6-0459-4b3d-b673-b864b468b8e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4601fe99-cd55-45e3-a3fc-a356cd9fc7cd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "941f79b9-bfc2-48c5-83b0-aa3256245c97", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "672c5c2f-a6b9-48ce-be6f-8d07c3c69322", "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": "45b71344-d925-487c-a3c2-585c3cb856db", "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": "45a08318-4359-44c2-974d-e7e17ff07a9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab93dca7-70a6-4367-82e4-3133b2f2a401", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56329650-97a2-442d-8991-6523b246db57", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a80501ce-1292-4b72-a4b0-d282e1f5b8cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba334f1-a1a3-4867-9729-40fed521b7ab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1461616-d562-461f-a70b-10cea3dd2209", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af708d3-96f6-45f9-ad97-0d1155a2f7ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d5dc206-12d9-47ee-84d6-016d5cc9a6c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0a56141-336a-4722-85be-36a603660c56", "name": "Update Notes Custom Field", "request": { "name": "Update Notes Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Note object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a49b9242-c35b-4510-b204-55660e68b09b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2255f5c6-b198-411f-a945-c304e54978e6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f910d67f-3177-42e2-a268-e5de368e0347", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6893d7d5-90e0-4e29-99d1-ceb210de1cd1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16fc28d8-1bcf-4cd0-b99b-13f92d8b1793", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d9b81c8-73cb-43ae-89ba-07dadd4c534b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53dcb62-78c6-48a9-ac1b-bb8d82fae659", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b79ec52-fb70-4eaa-b46c-38badb30932c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4ac27a-e117-4a4d-a6ef-b167734b0bd9", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8789f744-aafa-4d55-9506-d7306fc64cd6", "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": "ff108da7-fd85-4b5f-bd8f-8e7e440e2fa4", "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": "b911b1ba-5941-40d7-8e92-6e688981777a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12ee314e-38bd-4d5a-9f79-0ed00d29c572", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04e8e61b-36b0-4a99-98ea-fea0eed8d3f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31891ce1-b60d-4c7d-a09c-dd088cada42e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462b43e6-fcfe-4626-b9af-3b36ed28e76b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44a921cd-ac68-4123-a339-c23335631f7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d73af80c-b14d-4f2e-a55a-2a2c776bf12b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed5f83c-3fac-4b72-9165-21f44386d0fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ff20966-eaa6-4d12-9ff7-049990bd35a6", "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": "323bea56-820f-424c-bc15-cce24155b948", "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": "1b6a9efc-cac1-49cd-a0f3-74f53da82e31", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a536a14-6d67-474a-87dd-4a077d0f4a76", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e9659d-e5b4-4270-a021-f0ba591e0aaa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28cba67d-9c1f-4904-a957-88532ceae5e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad367323-b9a0-4b14-bf86-8f7c5bc9477d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48feac99-43ff-42f6-8fbb-bc13747117f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "218b11e8-52f6-4728-8ebd-fb44e6574fda", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef767516-7415-487e-9d28-5ea5662529be", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "607736c4-0872-4a79-95d1-2f9c5f9d1392", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b9767710-e4b1-4d25-bf6a-f464a4193ade", "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\": 2647\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": "1be8eb20-8b5e-4a1e-a311-543387019907", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cfab6e0-595d-4030-a5ec-dd8dc624f0ce", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d7d2c31-caf1-4ca9-8426-66afaae660bd", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2860cc7d-9e36-4993-aaab-dffdd71b72dd", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04842305-28c4-4b5b-9c63-dc3cff69a30d", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "defe66d4-1f18-43f8-ace4-757731c4274e", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75491700-5447-4777-a95e-6b30a98ef390", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ae5f84e-05cf-4e4f-a2f8-86e1f1e7e7f9", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18d5b110-ee04-4d94-a97f-81e5d02e8f3b", "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": "8ad6562d-5254-4da4-9b73-12eddf7325c7", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bd01cc0-e9ad-48a2-a156-787f0554f771", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ef55b50-87e7-4f95-9768-7e0988847bb4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f869113e-6f83-44a6-be54-ad1cb35a71a1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54470f4f-efb4-425a-afb9-9f0b15632a7d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe7b0384-b433-4df5-8a2d-eff947340dcb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1166df41-262f-47fd-8aaf-b0cf85d14bf1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "407205a0-ef01-4742-856f-c78b6f5a98f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08e8cd4b-0944-4184-8af2-41b4c7844b9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e46ce43-3742-4620-88a3-adc59559c91b", "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": "ebc425d1-1af4-4af0-b07d-1565809fecc2", "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": "112ef679-20c5-46d1-854c-e03dc48e5bc1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d39283b-4ea6-49ec-b64a-55dc74118993", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aefa557a-2a8b-4484-a803-ca5caa0e46d9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0689b260-f87c-4c32-8ff6-fb1ef12e88ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbb67c3-1a38-4024-a08b-396bfbe40601", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bacdc86c-18bb-4142-803e-8d5e3ce87140", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "161dc094-dd78-4289-af43-b229e53ef1bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "303a5733-f870-44f5-8509-736cf5c59c3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09f733c4-aae2-4202-9fec-a3e35a529e7c", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ff6e0b1a-e383-42b5-9ae9-69e7c57196f7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ec0751-1fc5-4792-bc0a-f034aaf84828", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea0cd2ae-7ed5-4c0b-93d1-e88cee08d467", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa7b77ef-efea-4930-87b2-90b4f4cdb33a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "035043c0-c8b5-46ee-9f3b-934282f0cca2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bed5564-d713-467b-986e-f5e9bc92fc23", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe8ed2c-fcbd-4ff0-8fa5-0853ea4167bb", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1326fc0-4e05-46fc-b6cc-7a2d36906002", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb4ef3d-8b35-4b1c-b1d5-4d639b91a998", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "notes", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af5208e3-6b77-41f2-98b8-0450421b588f", "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": "9e5f3c81-7e11-4bcf-b62f-8ddc7612e4ec", "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": "c526c929-dc46-4ff5-acaf-f4347757f6d7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddfa829d-1924-4822-b6b4-17cd352c31a2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8a6e655-a5ef-44ff-a68b-915ec683f9c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3bbd40-fae5-4cf4-9565-c378cfce7eb8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c3e108e-ce97-4c1a-bee3-f0256fad9fa2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ae2e206-f4dd-4e3e-8a81-a78f8a93be4b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc2083a-92fa-466b-9a1b-eba96c1bb13a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "125a792c-68ad-4213-af7c-07fb332c207f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41ef78ea-f49d-4e8c-85fa-ac2b6184e646", "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": "734684b7-749a-4467-974a-6c87ed7178ba", "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": "eb97dd84-38a5-4cda-9f50-d22623a69603", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ef7449f-2258-48e1-aa10-0f54a6f11507", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "924a0755-d46e-46ac-aad0-c5506347c073", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b3732a-752e-4559-bb05-b69acfcb9918", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe66cbe-88c3-43d9-a7c8-1911d535b48f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68a637c8-ed3a-48a9-b302-63c85c98aa74", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a325f19-946c-438d-a1ae-9b6a83c14002", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f5f2f9-b0cc-4eaf-b49c-b8b924464332", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20459355-a906-43da-a05e-14d9252c79a3", "name": "Update a Note", "request": { "name": "Update a Note", "description": { "content": "Updates a Note for a Contact", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "type", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "text", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Note properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user_id\": \"string\",\n \"title\": \"Follow-up Meeting\",\n \"text\": \"Discussed pricing for contract renewal\",\n \"type\": \"Call\",\n \"is_pinned\": false,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ],\n \"contact_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c43b837-50ae-4711-a110-24a50d5cf534", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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": "cc14050e-2c23-468a-b6ab-a931df785f40", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce25f61-dbdf-4794-b167-c362cf2fddb1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00087620-c7e7-41f2-b9eb-30619e1fd03d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b7c1d2-dd87-40e6-a33e-a173d41dd5ea", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f9446e-b2d8-426c-86e6-ad89a7710a15", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a8a3f6-bd97-4870-aaee-d1754b78c4b6", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "111d1e7b-780d-4e7f-862a-5a5f262348be", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83b34c27-8cfd-499a-b6eb-cad996b8dc37", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "contacts", ":contact_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "type" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "478e5d20-5fa3-46b3-9075-c3f5dfa05ea6", "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": "e81cdbce-51fe-4924-a2ad-da0ac09b5ab5", "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": "2943d324-6850-4665-aecc-6160821fca36", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4095630-f20b-494d-b8a2-31ab3d17763d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080c18ad-ca62-42b6-b321-4c6dabfa6870", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4015bbed-1b97-41ff-8105-bffebbab91e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e5e331-007a-480c-b7e0-98318e31405b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f400918-88a1-43a3-a0a5-b7e40fbdde44", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3610c46-ba46-4db9-9de3-739093a03a1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f4ee04-26a7-45ee-96c0-18850303640d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39217309-2a43-4dad-a699-bb2f5b79ce3d", "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": "ffc21331-7208-4b25-903f-7ecfb1a584ab", "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": "8ac71623-2d86-429f-bdd3-561b84ae496c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6513ec6-fd88-4ce6-8f7e-a341164b1a27", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a2d7fcd-a5d6-4229-a631-91e68b1b2eda", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "678a0f93-03ac-41e1-b5be-0592e1963dc8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c7efde-b695-4c55-aa4b-78cd8b304b4d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6cb9d4f-f2b5-40fc-aa57-6b62d0430b11", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03e38f53-04bc-4c71-ac25-247e86a15d35", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17fe2cc9-03d1-4f7e-935f-98b0ea0f0eb2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a65c0fb-6e71-48b4-bc9e-825d130136ab", "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": "e8b6c5ce-6600-4593-858f-522390c5323d", "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": "2de2f9d2-1a72-4564-aa06-27d8c61847cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73e27d30-9c0e-452f-b68e-5ecd7b2eed2b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec3cf5d9-3edf-463b-b47c-75cd984efab4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62bd689e-3570-4e73-bf30-f47bdf248765", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d5b7c0d-fddd-4526-abb3-78a21b3ff23a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8476735-b53c-4efb-ade7-060c450f997d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0972dbe6-5098-4049-a930-a05934f6a661", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59ca0975-18d5-4f9f-b606-5834ef1e67de", "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\": 5119,\n \"message\": \"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": "ede52253-e97f-4052-838e-f0e95ed4c12a", "name": "Opportunity", "description": { "content": "Opportunity endpoints.", "type": "text/plain" }, "item": [ { "id": "115ea3a6-c9b9-4909-8659-e5aecc8ed96d", "name": "List Opportunities", "request": { "name": "List Opportunities", "description": { "content": "Retrieves a list of all Opportunities.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string", "description": "Filter to apply, allowed fields are:\n- (String) `stage_id`\n- (String) `user_id`\n- (String) `contact_id`\n- (String) `opportunity_title` — supports wildcard prefix search (e.g. `opportunity_title==Deal*`)\n- (String) `lead_source_name` — supports wildcard prefix search (e.g. `lead_source_name==Web*`)\n- (String) `affiliate_id` — exact match only (e.g. `affiliate_id==123`)\n- (String) `opportunity_id` — supports comparison operators: `==`, `>`, `<`, `>=`, `<=`\n- (String) `ids` — comma-separated list of opportunity IDs (e.g. `ids==1,2,3`), maximum 100 IDs\n- (String) `contact_phone` — matches the contact's phone. By default it is an exact match against the stored value, including any formatting characters (e.g. `contact_phone==(480) 123-4567`); it does not normalize or search across an unformatted number. Supports wildcard prefix search for partial matches (e.g. `contact_phone==480*`)\n- (String) `contact_city` — matches the contact's city; supports wildcard prefix search (e.g. `contact_city==Chand*`)\n- (String) `contact_state` — matches the contact's state; supports wildcard prefix search (e.g. `contact_state==AZ*`)\n- (String) `projected_revenue_high` — projected revenue high; supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `projected_revenue_high>=1000`)\n- (String) `projected_revenue_low` — projected revenue low; supports comparison operators: `==`, `>`, `<`, `>=`, `<=` (e.g. `projected_revenue_low<=500`)\nNote: `opportunity_id` and `ids` cannot be used together in the same request.\n\n**Custom fields:** opportunities may also be filtered by any custom field defined on the Opportunity record, referenced by its field name (e.g. `cf_priority==10`). Both indexed and non-indexed custom fields are filterable. The supported operator and value depend on the field's data type:\n- Text-like fields (Text, Text Area, Name, Email, Website, Phone, Social Security Number) and choice fields with text options (Dropdown, Radio, State) — equals (`==`) and prefix wildcard (e.g. `cf_company==Acme*`)\n- Numeric fields (Whole Number, Decimal, Currency, Percent, Year, Month, Day of Week, User) — equals and comparison (`==`, `>`, `<`, `>=`, `<=`)\n- Date and Date/Time fields — equals and comparison; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `cf_renewDate<=2026-01-01T00:00:00.000Z`). Date-only values such as `2026-01-01` are rejected\n- Yes/No fields — equals only, value `0` (No) or `1` (Yes)\n- Drilldown fields — equals only, integer value\n- Multi-select fields (List Box, User List Box) — equals only, matched as a contains search over the stored selections (e.g. `cf_tags==red`)\nA custom field that does not exist, an operator unsupported for the field's type, or a value that does not match the field's type returns `400 Bad Request`.\n" }, { "disabled": false, "key": "page_token", "value": "string", "description": "Page token" }, { "disabled": false, "key": "order_by", "value": "string", "description": "Attribute and direction to opportunities items.\nOne of the following fields:\n- `next_action_time`\n- `contact_name`\n- `opportunity_title`\n- `created_time`\n- `update_time`\n\nOne of the following directions:\n- `asc`\n- `desc`" }, { "disabled": false, "key": "page_size", "value": "0", "description": "Total number of items to return per page" }, { "disabled": false, "key": "fields", "value": "status", "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": "custom_fields", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "59ee109e-43cd-4677-9479-37b6b8c993db", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "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": "a8f1b962-76c5-421e-978b-ce6e3025e54c", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69711d5-d9c4-4899-99d5-be2281d8839c", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9799487e-ae04-45d2-a9ed-8f5dd41c0ed3", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59ad64dd-5d84-412d-a049-e9353e47becf", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37aa170e-b4cc-49e3-9650-7d855f69e588", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f80d27c-a593-4ed1-b8e3-b3795590b562", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e86a1cb-eb2d-4b5c-84d1-6213c48c5cec", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b85e3aa-2ac1-4833-9d51-b6f960fafe2d", "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": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "587adfd5-72f7-4975-b769-5f6590fc4dee", "name": "Create an Opportunity", "request": { "name": "Create an Opportunity", "description": { "content": "Creates a new opportunity as the authenticated user.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "status", "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": "custom_fields", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "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": "56147f02-d475-4425-9cca-dc287504ea02", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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": "7b3f3292-6f5e-48f3-a46b-00296d6a942c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf3f06f8-45cb-41ba-8990-b120f757f038", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1457b4d6-697f-4f5d-a457-4c497058de16", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f22a5d22-95b0-433e-8540-6e41d73dc758", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8027547b-489e-4745-8f6d-ed9df8f2f045", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af3fbe4-84aa-4953-8ace-c597d2ba12d9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ef2e182-5338-45a0-b471-ed5c35f68baa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153461ca-4c56-4310-a4c3-a826d7fbfc7a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a 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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da03faff-4a8e-4098-b7f2-b095ab8e7d02", "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": "35c3dedb-9808-44b5-8423-fc3c5275be4c", "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": "22b7ac08-7758-436b-bca5-7ebd7138a4e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63fc832b-0d5e-4356-8411-73cc1945e266", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b90b84-9fc3-4b3d-90c6-9d1f1898d527", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ef211e-6eeb-4d11-85f8-1687be16d211", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707741a9-c5fe-42c2-a079-32712806c751", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d816d4c4-7ab9-4e57-b011-a08b51a19718", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc06322f-dd61-4834-a663-ab5d030d220f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e38c1a0-cd52-4e71-85da-690972c13749", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83ffd127-ea95-44f5-9bed-0b5513aa634e", "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": "50fdfc30-4549-4924-afa2-710ae99ea529", "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": "7d64bdc0-4da7-4cb8-901e-06f9a3df60ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c937bdea-4315-4249-8da8-87d0b2959d1e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a73cc329-a5ab-4e88-b768-136ea3499430", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc327b7-cf7b-49ef-803f-6d65fcd6e359", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abf06878-a89a-4e4f-857c-227e11d39624", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9957f04a-4ec1-46bf-a595-489ae3e59860", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3e20402-ca28-497b-a6a9-214904a3e25a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44f16db6-2aa0-499c-af28-5a7594cca2ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3479eb92-248c-424e-8391-9b78dbf16456", "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\": \"PERCENT\",\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": "2bab532a-6915-4064-8f72-ab9cf4ae60af", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bead1b1-2320-47bb-abd8-3e66d3680582", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27fc9b70-6970-46c9-b805-eb4bb20e9b16", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9b0eba-c3a3-490e-ae4e-25db8f7ee676", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94d4246d-e1ca-480b-92bd-d1f0fb4b149a", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6662ed47-fe96-4487-8a77-331894ac0599", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a58dea-7592-437a-a422-79963ec9e3ad", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "554071b3-96b2-4ef6-ba31-c3585911c2d7", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf4be121-3086-4962-bd34-eaa05c43dae1", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3157af3-9f26-4e6f-86f1-22279fb8ad13", "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": "f492b3a4-804a-4064-9349-e25229bce644", "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": "fea17839-22e7-46e3-aff0-6e4c93e684c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1eb0c9-8189-4613-8f89-bc00d2258899", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43c8aa09-ff37-4595-9333-39d5e1bc5b06", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7553b3-f698-40fb-84db-cdd0c5aedf09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38425123-954a-4258-ba4e-c8d6e5da65d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b8595a4-29bb-42d6-9652-9fc6891b8b65", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9f515bd-3068-4fec-b1b5-c02ff57356b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "697bbf05-9e23-426a-9d71-64a7c0c2625b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e885cb53-ca94-471d-9d2c-dc9b9e238cbb", "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": "21c81ca7-f639-4080-a507-b67445883848", "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": "a1ed40ac-9abf-4a05-bc53-477d178259e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "755ccb7e-6051-494e-b6ba-028c5f35b8e8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688088a0-4e91-4a00-a274-2fc5999a929e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f71a1cc9-582a-40e7-988d-036ef8fc1382", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f7c3d4-ad1a-4cc3-980d-6744e6ff3974", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e403b4e4-ff26-43ee-9964-40a82f0cec03", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fe51604-1f27-4e4d-a53b-9cac6b4ff470", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814bdcb7-f474-49fb-847d-780280302914", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88ddf883-a77a-4028-b7d1-6fd1784fcef5", "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": "69de35a7-0374-48c4-a62d-19a8661716fa", "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": "44d73506-95cc-42eb-ad4c-3dfc3ff8e660", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c159715-9999-4da8-b844-feba9b905848", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce399c8f-8255-49cf-951b-401ea83c232e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ba6e0a-ca97-4191-bdd4-98bb95a318a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc8e742-14b3-40b5-b0df-1be5b5d00c8f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca48a78a-549c-4e36-9a16-c70b70529977", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0beac95-dee0-4fdc-9ef6-34cff0ae53cd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fcf10f8-720e-4470-b75d-a2309628a290", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2deaedc-03c9-4d2e-af76-d8e272c60210", "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": "2af40f73-7dac-40fc-946e-002d637a7b65", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "551ebe56-a599-447d-a679-d16ef5ac3185", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18dac509-3c64-4e65-af7c-a8710dd24a4d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a99014-11d5-4cab-8cfc-5e81d85cc8d2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0581c721-fc6f-49dd-947e-187cf4877972", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "917a93c1-ba01-4be6-99bc-f6fa7f4ab30b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bf0e1d-aacd-4029-808b-3c8776021e00", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abc5a828-3b71-4072-b1ab-e7013f99dfbe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0791e3ef-a489-477c-8429-e9f3b858c4af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c189ee8-3f5c-4074-ac9f-6760f34fd693", "name": "Retrieve a Opportunity", "request": { "name": "Retrieve a Opportunity", "description": { "content": "Retrieves the specified Opportunity", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "status", "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": "custom_fields", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "opportunity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3723166c-b15f-4428-ad12-940a9e64d11b", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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": "20116805-9182-4e01-a050-a11fd312c346", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e3ca064-4304-4a25-9c1f-0dde2cecc173", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ad2bbda-fa6d-4722-a59d-87e8784a729e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ae1c014-f71b-4b82-b515-f488c896bc09", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d652ae58-5c36-4487-b7a3-5ed39b453f89", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f991dcd-54c4-422e-b5ed-8653edc5edb1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ed011a-f024-42d9-84b9-b05b5393034c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d55087-1f6e-4139-bf1e-5b6d9dcd87be", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2220869c-1343-42f4-ba5a-4b8c2b09130a", "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": "09b18fee-0f26-489b-bcfb-a6cc76ae4368", "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": "2d9c5a70-2912-4e43-9ba3-4932d4a15c4b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd3c0bed-4a90-4e61-aafc-f13d272a9865", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c69ad1d0-5437-4c2f-a44c-7a1279f38d48", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf01b349-fe9e-4021-a5e2-389e4873069d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b60d68bd-b9d1-4c01-8dde-16a5893d5a9c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4541ae92-7445-480f-b2dc-b5ed01895c6e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a07efacf-f148-4fe7-be38-85bd41b3ea4d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aca20dc0-7b58-4dff-9f6e-40bc6a0a7d25", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07d60715-8a17-469b-8fc7-29de15b66b0e", "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": "include_in_forecast", "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": "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": "fields", "value": "status", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Opportunities properties to include in the response. Legacy field names are supported for optional fields only if legacy opportunities feature is enabled. Allowed optional values: custom_fields,created_by,last_updated_by,status_id. Allowed legacy optional values: monthly_revenue,order_revenue,objection,status,stage_entrance_time" } ], "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": "3dbb61b4-0c21-4b67-86a2-7482d5cf5880", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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": "4b267758-e591-45e2-bc58-8c99cf8a434b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5a48cfa-4db8-400c-a380-c7412a7d4dcb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f957e09-f634-445c-a53d-e37b2c89a93a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d83998e-1e65-4fae-8bd1-160eceede415", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2651bb-4216-401a-8387-1659509e506b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e09316fa-5fbc-4a74-8ccc-d347cf95ff1d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "177c4bca-cecd-49f5-9992-f8490d4fbe5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e2de11-0a31-4003-bed2-a9886dabd926", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", ":opportunity_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "estimated_close_time" }, { "key": "update_mask", "value": "next_action_notes" }, { "key": "fields", "value": "status_id" }, { "key": "fields", "value": "status" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adb74a61-4a68-42ea-8501-bdbd10968218", "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": "f7cb6e86-8ad8-4541-859c-8c131feb3f33", "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": "f035bc36-1a37-4d72-b4fc-456d13df0ae5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14089ccc-8115-4a79-8bb9-64b692e5160c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429bf4d1-1806-41c2-96e3-25ff9170e753", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c1ab90-5488-4703-8cd1-eb6b92150c43", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d165e97d-c9d6-4251-9584-c5094235280e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef997d0b-8b32-415a-9567-021eb330b7e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f19532-7e12-4c38-9a06-13635063aa5d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8f56fdf-3a61-4122-9b59-c6f000f08587", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58ebed50-a560-41c6-88b4-2c549c6fea5b", "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": "db750e9d-3a0c-48b0-9c78-10c67db37166", "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": "7fa73a3d-9045-46dc-a8e2-1fd7f3e98bd2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409a9deb-fc95-476e-a51e-3223c74d6936", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205a7f11-c37c-447d-a5d8-994c552f8de5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdfa13dc-f407-4f62-99d9-7d9332914806", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d792eaf-7d11-4d68-8d16-f7be02e4560d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebc2eb53-6cf6-4626-a64b-e338119a5a45", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fda1c8e-3c1b-4c71-a795-f3f1a47b3488", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280bb3b9-b7eb-45f7-b5c3-0b022ca15006", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6afff5d9-248c-4862-90a2-3a2771791fa8", "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\": 6765,\n \"probability\": 2,\n \"target_number_days\": 610,\n \"checklist_items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6b685777-b755-49df-aafa-42cba919a79f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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": "01b70497-9be2-4935-ab78-2a1190934c2d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80118f50-b8bf-49c9-9dce-054a50e722dd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb3b2338-150c-4666-a04a-104099fb26cf", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af5a01d8-5aa0-4b90-b996-50d8a4f8cfb5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e52b4042-4759-4093-a12b-d2a4cf844ff4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6bcf627-b5aa-45bb-b1c2-972857684dd0", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48f8ee84-1e21-4c77-aa13-c269968ad3aa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d2a415-5b4b-49e4-af19-8f9ce10dd61c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "stages", ":stage_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "order" }, { "key": "update_mask", "value": "checklist_items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "stage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Qualified\",\n \"order\": 2329,\n \"probability\": 2,\n \"target_number_days\": 2849,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "526afa3e-e7af-4d6e-8155-4cad91750454", "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": "ea6ea48c-b754-4d58-a0b1-22cc990b2989", "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": "155d27fb-75b1-4833-811e-d27f5852939c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ce37b6-9ad7-46e4-85eb-63e0280840e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97e3e930-3254-437e-a743-576b9dfea29f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3951b22-8e06-4353-aa87-b5570f1ce1b8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95db88b9-b36e-4e2a-ad6f-a592919e17f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8833365-c299-488f-892a-c07b2441d2cb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1dbf413-6444-4977-b54f-9d4267cea56b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13ef03ad-7d5b-4c3c-8a70-6686babc3e7e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06d9e0b2-6842-4478-bbc3-8fa00e3c9779", "name": "Update a Opportunity's Custom Field", "request": { "name": "Update a Opportunity's Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Opportunity object.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed609491-c00e-457a-9e99-6b1ea953a478", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b333cf-5320-4081-ad64-cc1776769ebc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecccf04f-d58b-415a-b63c-8a701ab85f04", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dbcd2b5-bf27-4599-978f-32c2b9c5e742", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aef2206e-341e-4bf4-a96b-ec74ac728b3d", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3845fe51-fa1c-4e06-8813-e75a951ee720", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f3c8f02-60c0-4a85-bf62-a4fba79510ca", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e4a09f2-74bf-44e6-aed3-061ac10d5749", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75635f9f-354e-41d2-88eb-a21e7c3c0551", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce0c6554-0fb9-4368-ac15-04e2c9e25206", "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": "07e25ae6-2979-4723-941b-0874e075e5bd", "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": "815ceb8a-a046-4eb5-b1f6-7df0415064e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1d32a8f-9fca-4e01-8bf3-c5a84d61b30b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52bc047a-af11-449a-8abc-3e06af898303", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33027833-cdd5-4612-9b42-268f27e85096", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ebaf37-194c-4d27-9fae-bdd87c3738c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d55918f-1e34-4e07-9ca1-0f6edfaef494", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98b6d6b9-9a5e-4671-871f-900f2476556e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae84cbd3-61e4-4888-bfa3-33161f9c0754", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7136917-1aa2-48a7-9ad5-cb23331ea493", "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": "1b39aa3a-aa82-4a67-9806-5a28fceea1dc", "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": "23a4f9b6-7bfc-465a-b5bb-0d199bc2400c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b72c645b-23ee-4f69-ad18-3466d27a6ff3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf427f5-6a80-44c8-8aca-912c2fdd60c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1583bd9-0dcd-46ad-b4c1-de81d125e4dd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0fc4fab-cc74-4e62-9244-8dd60fd1f7c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c7837fa-d93f-41be-a23d-8255898e8bc5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ecd19dc-83ab-4ef0-9e2d-bc28e438412d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb5f8433-855c-4b02-b4bf-bcf74085130f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca950b89-0aa1-4c5c-b30a-28e5632be78a", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db29e077-3a90-4e0d-b7a8-5efb902defea", "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\": 2647\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": "50f81ffd-6696-4629-af91-a6003aa4e7f4", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e34f0cd9-7ffb-4faf-86a9-1ef6875180f2", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd92df5e-1262-496c-8de9-7daef417849e", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572ed076-e17d-478d-80f1-29057cedc83a", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ecbc91-e64b-4fdd-9c9d-49df2dd884ab", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6627bc38-1029-4f84-a157-432b08da04a6", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14cae116-e5b3-4d16-b138-424199c3bd14", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a603593d-6b1c-4a00-9acc-6f935b68ef91", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5085ff6f-dbed-4e16-bc29-c3d2ee16819f", "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": "fa65ac4c-ee2c-4272-b116-9079aa03e124", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd2be97c-f48c-4ab6-a97b-eb2c176bc475", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff6aea1-a185-4b50-8f98-b2b2279cab1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd77d10-43fe-4958-bfde-abd7773da8a3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "435af102-4cdc-47a9-82c2-746315b7e1e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89ab00c6-5bf8-4d66-b9bf-ef992ad2b668", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c832ec2-1b54-4f6c-9141-21d934cca5f3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b75e2e-de2b-4134-b666-843921394528", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04d5045b-e050-4411-ac9e-ab4f3bc821bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6115b898-0fa3-4a1a-a513-d177d1b20a6d", "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": "f77c9938-2432-47ec-bf7b-6a327cda3af3", "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": "47dd2358-2e82-4519-aa52-28b7c6da9dd4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92313317-36fa-4c1e-ac62-6f5fd053428c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "145b5cec-6c57-4fdc-996f-e02d68793587", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf4f7987-66ae-485b-8e88-3cf4fa27f933", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db5284f-2c7f-491e-8766-227b5d341b1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77185d0a-8357-487a-b4b0-8bc2aa20c603", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3df1090e-4f04-4789-aa50-d18d923c72f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c71e92a-7795-4b7a-b0bd-400fc246f90b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8fd6981-2888-4a5b-bd48-5d6f8d18723d", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "411de01e-a591-4ed9-9007-c623bc62ad16", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c7b2467-a3e8-4ad9-a07c-5218a863434d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01ad9bff-0ee4-4402-a8d2-df5a59365ece", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4f6e3a7-2c1b-4b8a-8a41-05ca86359089", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02354b81-2b96-4a28-9751-ad7a22b908cd", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9de294a-487b-4723-b6f8-94768e1557a5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79d69c39-ede6-4dc4-87de-f6ea2c7cf67b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "026918a4-24a2-446f-8604-77cdc4151d24", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01538de2-0063-4575-874c-37edd8714fc4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "opportunities", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37e9ac5b-a51e-4b4e-811c-01e16eaf3124", "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": "f9dc4740-06ba-42ae-97df-d6f83cfb60a1", "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": "9da16e9e-6b35-45cd-8318-37ef2df8bd90", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd750d26-df22-4cdd-9446-b4b70dc22fee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f52e845-8e73-4d01-b1a3-177b6c4f3f8b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0643057-380f-403b-b3f9-82ab2f4cac5d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c1e0c8-1a6c-4cde-9ef4-455a889e7f99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52bd091f-13e1-4ccf-aa94-911f54849185", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488151d0-e293-4916-a6ac-8cff728b9567", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d8c12ab-bfad-481c-9798-2b947351f538", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10aaf455-285a-4eec-9a07-2798911a1f42", "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": "250428cb-3958-44e3-a831-698bcb2985e3", "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": "f74dd25b-6c8a-4881-a058-04bb5f060a2b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a24376-ab0e-49ec-87de-86216f12a4f3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c98aa39-4a5b-4f11-8b47-fa1f19b4a179", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a23ff66d-1cb4-46be-9bba-9522d0f94113", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf2cf014-fd69-4cc4-a96a-e57c3498dc5d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ad2f23-d0b0-4d17-b6f2-4d4752f69f8b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad9a9a8a-f151-4e31-82f2-ecbedbecf8a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0645419-8f9d-4c9c-86b6-00dfb7ec0e6c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d678040-27a8-4be0-8c01-c5c8545ef6f4", "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": "8c4aa3fc-c771-40ed-9edb-f29fd9a7a5c1", "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": "65ff189f-1ad0-4f4c-8346-d4f60cc1f987", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78bf73d1-5017-428f-aa8c-4ce17c695b1c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd503988-79c2-4802-9976-ec48dbbb015b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "556e73be-730d-4596-9438-7a5f62b5afb7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b61e2ab-6a69-4dc4-b81a-d85c876651c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2453c76d-251e-4b54-8eff-f119bad79e24", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dad161d2-3783-4fc6-9a57-43634c1fdcea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4a1ca2-2d04-4854-9053-afaf49e6933d", "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\": 5119,\n \"message\": \"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": "0f493aa6-2204-4262-9102-4abbb87bcdee", "name": "Order Total Discounts", "description": { "content": "Order Total Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "99e5f6bd-d776-4bdb-993a-b4d32fa9305c", "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": "a560074f-69ab-4b54-a226-b6a95e33a836", "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": "1d586bf0-f5d3-42a8-93ed-8c84b2a8ea09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66cca695-6804-4854-86e8-fb6304c72460", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d624cf9-e6ce-49a2-93a9-025e132e0637", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b6263ad-fd6b-4427-a38f-26e0c4a33e0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f698f75-e9d1-446b-b895-ac94d71c624e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fb2a9fc-d4a2-4e88-8799-5dca7de1bd84", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a135c143-7783-440a-9fbc-a3c416888a94", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83af7920-d305-4bcd-bd6f-dceb2943c005", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb0c4fc1-b4fb-4b96-ad8b-dc47dc2760b3", "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": "e382b518-f1d9-4e2e-84dd-d0166b32a3e1", "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": "a95076d3-b59d-4aa3-a781-9548462f0b81", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29879b42-6924-4a00-8785-3fcfa98b9aa6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbff93d6-9cb2-482f-882e-d0259aaef5b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1812005b-e4af-4fe7-8908-e49f8e652ca5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbfd1247-a0d9-4dbb-86e2-9e6063677845", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a9bd4a8-6740-4239-b3f9-c48e9aa7ebbf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbbb5345-3668-4063-aeb1-30f47dd6fccd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7532a0c8-e616-4944-a015-2d23052db23d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4160b44-d8fe-41a0-997e-7bf49242051c", "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": "9db8bd04-d702-44dd-8342-255468fe201f", "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": "76d8045b-620b-491b-88b2-fe85ae377856", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a199c7b1-abff-49bb-ac62-ed818b3dec4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5f22d0-612e-47f3-b715-308aea035679", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "406c0f23-e551-4017-8c92-9434c00fdf99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adb937b9-2a0c-4efb-a172-63354ce454a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe6d436-2a11-4105-ab17-459ae566b8cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b74ba66-4a24-4a77-9012-7056eb984f64", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c35a96df-5e96-42d1-9d5c-042cadba5371", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aeeab784-1f25-4a41-a1c5-6ee2c782118c", "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": "9d26edc5-3a02-49f2-877b-a3c62db7f96b", "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": "1d4a22b9-af61-4f8e-858c-1fe64ea51610", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c56d065-2a14-438f-9db4-d346498fedf1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abefe1b3-dffa-4250-863d-0a250643e1ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82647ce3-18fa-409c-a3a3-d64c269b79d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38a90995-1f6e-4533-8930-90e4abd7ccb1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c101f98-7740-49ec-bb58-23f1c12a9f03", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7381a20a-c171-4a2b-962a-ad561475de78", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20030384-7647-44a3-881c-f398b509c863", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b736a28-c6a2-4edf-8039-4e1bc6803eef", "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": "fdf45503-7447-44d4-bc75-6d10b91c39e8", "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": "54c0e4d0-62ec-4132-80f1-47dfea19a9fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ae2d830-be7c-4afb-8da5-05dd72a186bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5202e6a-e814-4d22-a4c4-9b1a221d48df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3b49489-94b1-4e5e-b094-93880c7122b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2579ed-8c9f-4620-8654-2eddddb7b7ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "240be5cc-0757-4a89-b8be-50143d338b9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b26aa2-2ec0-4da7-a830-5592cf8fdc70", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf63a21-d165-4a66-9995-cce53b3410ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4246617a-b065-4e48-9115-35598d90387f", "name": "Update an Order Total Discount", "request": { "name": "Update an Order Total Discount", "description": { "content": "Updates an Order Total Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "discount_type", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "criteria", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "discount_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Bulk Order Discount\",\n \"description\": \"$50 off orders over $500\",\n \"criteria\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"apply_to_commissions\": true,\n \"discount_type\": \"AMOUNT\",\n \"discount_value\": 50,\n \"discount_strategy\": \"GROSS\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f1ef597b-d19b-4757-a854-cf94b6d25174", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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": "a8ca2b24-6697-40be-89cb-56088f890f3a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acad2e80-7e56-42fd-b7be-67ec11efae18", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1c0872-3f86-49be-81ad-6bf0a922a460", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d68fedb5-ea67-4d22-b991-189efa1553e9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "492d17b1-e251-449e-a87f-6c7f7044781e", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597f9dc4-5e2b-4006-8b44-b1d5db2cf94a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9191558e-c47d-471e-8f15-1d4e1e441749", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b0fdb0-75c1-424f-b7fe-48b21626db65", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "orderTotals", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29b09c66-99a3-4b43-93a6-e2970f9c46e3", "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": "b697a70c-5216-4f30-ba2b-f589629d9105", "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": "aaa98f98-22ba-4303-ba95-be3ab9c7c93a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be022394-71b8-43ff-9a7b-d503359c6139", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67426fa4-1d57-430a-9948-eb943a4ad1b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d12e548-9aab-4ae1-b5f8-ad3b85a84745", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bce3918d-8680-49b2-aca6-598188c54edd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e2524c-8a82-49e3-8dec-15dbab195a14", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b032a65-dadc-4221-a2d7-7641765719dd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "897e35cd-e689-4dac-aa33-bdab26b638b2", "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\": 5119,\n \"message\": \"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": "5beb8d5e-2d65-4763-bf4a-9ef97d386094", "name": "Orders", "description": { "content": "Orders endpoints.", "type": "text/plain" }, "item": [ { "id": "7ed8fea0-eb24-440f-8d29-e80cacccd416", "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": "4e1e03e4-3540-4f2e-b1ee-cc1a8172fa0c", "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": "4acfd647-6110-4ec0-8870-8647aa238911", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "461e8730-ee11-4190-9242-247f25e30e7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "498fb1d8-19b9-46e9-b687-690affb15c7c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a4a7a6-42cc-474d-89cc-21fa52c13e64", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d95a579-17e2-4756-9fef-42253fb86b7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acd7127e-1d93-4610-b39f-27a3935f8f5a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "282277ed-a321-4c49-a5c6-d6fc656998e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2d3f0e1-860a-41ea-9c04-5010dcc939db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e5e5f59-4bca-405e-b6bc-a933f42744a9", "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": "af5f4162-3ebc-4fa4-ba2a-1e22570c5edd", "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": "3c194c84-12df-4a30-af8a-b8c188543b32", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "043ac2b5-94ca-4a65-a479-92939728630b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8600f16c-57f5-46e2-a24b-343dba654979", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a6634de-e8c0-4490-be41-894a55e03923", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "918afb3c-21d4-434b-aaf3-73332ce8fb92", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea323aa3-2d52-4952-b724-79f277294e60", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d626311-dd96-430c-8941-ae6f22975cd4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "370d394b-73a1-41ca-a1e7-c0cc0b78bfb3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16164feb-6cc8-4141-9c55-753c41f97805", "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": "50163c70-ce6f-4a71-94cc-d4e75d410050", "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": "9d71d8a4-c87d-4dfb-985e-c55fa3974509", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1865768a-1446-4b30-bc3b-0b7289906fbf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7965f7e3-a09f-45ad-bf79-b96671fe97e9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d312b8f-d482-4ef0-934b-9ca2fa2961c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7755e668-55c7-4ca5-b8f4-2f8c6eef7b81", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7189a4d-d385-4dcc-94af-66f01db03a4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7cea634-2320-4039-8051-aaf05060e52f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ebcd410-6af5-4cba-b44a-69653f07e63b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66796e13-8df1-422d-8cb5-3f1c3e666361", "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": "578e3297-d009-43c8-8479-c4b70307c9bf", "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": "ce4fa237-d449-4cc7-838e-087657026d89", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1eff3f3-6a65-4235-806d-5e06f5da5df6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b21388f-9228-498b-8d62-eadefbeadbb5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aa00378-74b1-44f4-a49f-effed09be23d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1b21a0-39e2-4491-b972-3bdc8393e35e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6872e4d3-b257-4655-afd9-c2e8b289a339", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7eaad07-d5c0-4350-b83d-eb2713979152", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8acddc3e-a8d9-4647-910f-43f832dd4533", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09a7a7cf-9b81-4806-ab44-aef9e0d132d8", "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": "bd31da71-ddad-4b7c-8a64-17d9696b9210", "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": "c11486fa-a559-4c2b-9f78-2a92fe5190c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "694f8ffd-5a80-482c-8ed4-ff0cc9168644", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64d228e4-d08c-4f8f-b4e5-874f0683aa69", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b88598c-0e6c-42ae-8d06-a11167278dd8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0306b09-5fe4-4d9c-b215-14130eee64ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c1a508-a0cf-4b18-a3f4-5260b987214a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d6d1f1e-7edf-433b-9e57-42d552d7d717", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a424001d-4476-460e-b792-3e902a3d8d61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4905285-8c9f-42f5-becb-314201ca29f3", "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": "3ed9ecf2-7079-4151-9e4e-a81554c20b7b", "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": "dcbe47d6-d6c3-496a-b083-65a4f4f00805", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c38475ca-1def-4bbe-b7d8-091a890e6f72", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff165ed-a433-4d72-8e0d-46925ac53e33", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a3a4fef-8505-4d3f-a061-f4d6c97b054b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b953486c-be2b-4f24-af04-91ecff0fc1ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d826a9-e74b-4946-8554-391de4d5e9f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cc77d62-a4ca-4bf8-9786-267e609e90d3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91539e81-02d6-4869-a3f8-6edd20bf5b95", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bf4acf6-a535-48ec-ba26-c1f9af4daff2", "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\": 3187.3794463326767,\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": "7f566f64-11c1-4b71-a3d7-ff54538b70cc", "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\": 3187.3794463326767,\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": "f1f12ded-5c3a-4ea3-9e46-791118f055e8", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d5e48d2-28c6-44a7-b25b-ca1a332b990a", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ca5a109-48ac-4974-9f86-5c673022257b", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1284316c-2b2a-4760-ab6b-24d908a079ea", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25075686-24a6-4fb6-81c1-b5652b6fdd63", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f58994c-d00a-4bb3-a32a-60177c2a27bb", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd9ac5e-cb37-433e-858d-bb4c57f2687b", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d33a5457-f26a-4397-97b5-79fcfdc7ce81", "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\": 3187.3794463326767,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e282283-5eaa-49dd-a53f-c8e86a667068", "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": "9e20abf0-362c-4655-9517-2ef46a604245", "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": "8f0826d6-2112-4caa-ac8a-de8ae5096fcd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "debb3358-d79a-4324-97ab-d43ee4526dfd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1d9905-b737-4f6b-ad67-4bf0072716fd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24931df3-a403-42ba-aa42-83c6fda7cd0f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7527d989-4a10-449a-9d39-1f1bedcb1425", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcfdefa4-29b2-4d31-886b-fbdd0940f1ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "571707e9-7719-4e37-8ee3-818181cf81c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4747dab-a05f-4995-8dd1-6d47e63f6776", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fdf359a-ca4f-4932-8fa6-ccb064b48c95", "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": "aae621bf-7eac-426c-ac07-07a0d61055e6", "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": "c504153b-15fd-4960-8f0f-7fe31b0377e3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135a517f-fc37-478d-aa8c-46266f89c8c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30044c5-f0a9-4c40-8dfe-414ede40f6e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8804703-8f4a-4464-bc08-1db01ee0239f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8df5cf98-7fb6-4457-81e0-d613c6910a4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bd22768-8094-437d-ae2b-519e04498ee8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65f9757-3760-42c1-a800-71bb03b88f28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9905dc15-0266-40fb-a49d-a5586fb4fbaa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dafb62a-1754-405f-8101-bb3ab1cf622e", "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\": \"PERCENT\",\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": "0a525afb-54fe-49f6-84d6-bea73f4f8b5e", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1a4c14-fb2e-42dc-b084-036925f4b7cf", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2126ff18-339e-42d3-b98f-68299bbde42b", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c82fa9c-ceb7-459c-800d-bc03a8d8feb2", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b27b5fb-b5a2-441b-ac92-b9ebf569cc59", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f65b6147-6dd6-4b1c-bdbb-cf737df7439c", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32a6a08c-506c-47d5-b3f2-46aeadfe2721", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4752531f-9539-4b02-abc2-290b3a2dba83", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ec81c41-7815-4348-8755-8186289d2221", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6704bf5-a2da-40c0-b41b-779c9ebcecb4", "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": "8876284d-0074-41a3-833c-ed05ea8d3293", "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": "b8b12432-5b79-430c-a0fe-ea4dc68b0e30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4a7d556-5409-4fc0-aa1f-9844e2b18675", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e981babb-ffb2-43af-8b35-5eb2a3e9c0e0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c27c40a-f414-4db0-8bc7-89b39bfcad28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a553707-6f00-4ad1-8345-813991890066", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d8d58c-bd32-4bbd-a162-08017062e1b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "def147fb-a4c2-4113-a20f-24115394a21e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46baa820-cfc1-4853-b073-fafab6a0dc4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9e1ced8-7408-4ade-84a4-e6b7aa46430e", "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": "a8ad310b-68a9-4f56-abe7-ecd13018cbcd", "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": "018a0e78-4b8c-4827-aa0e-cd67c716f61e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3e17f6-8b83-47e6-86ff-a926e2238c10", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0a8fbc4-30b8-45ef-b2e9-8009e19496d3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db62043f-fe57-457d-ab39-6ba6727f79dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be72a796-3927-4832-b0bf-89f49525f1ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2700b18-96dc-45e8-a405-df99ae766454", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d7f5428-aced-45ee-89e1-145d0cef14b0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a5778af-24e4-4bae-9b02-e15772038af9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92c81475-e9ad-4708-81a9-e458affbf0ec", "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": "c0d4be9d-6691-4684-9554-b5f8a1eab0c4", "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": "b6cb8c04-4e35-4edd-95ef-a34fc752b817", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9d7463-952b-4b43-ad37-408e07af77cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d09371-8162-4998-af84-f433db1fdabd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b1964d6-04c5-4f41-b364-e75eb5c8fba9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44214d92-2287-4953-bb3f-051f340218a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1074c133-391e-4561-892f-8aa0a390abea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51fa2dbf-a447-4ab7-b882-8f7cc5cab01b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "032647bb-9f7e-4c42-8688-a91b3b24256d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ff1f3c0-9d80-4a21-913a-5e1a74c0c3a4", "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": "27b07464-238b-4d70-9ee8-99143d6563ef", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea62c683-6219-45df-8859-e2baa4f617c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74d5307a-8b2a-4dc4-a1c9-820f08e6b7d2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9585a5eb-6ab9-49d5-90ea-c73924eaa86e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e9af41b-d904-4a58-90a3-a6a93cb8de70", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "825bdedf-5cab-4da6-925f-13af0d83f01a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cbc3b4a-2ded-4e5a-9dff-6efa65a7ef2e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f455ba-12b3-4237-ad0a-9badd3000608", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e935c453-dc16-4be0-94f3-4a4628594630", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8958dfa9-659a-4963-9a4c-26d642c320c1", "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": "7953a758-e27a-428b-8625-f520deec2b14", "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": "e772251f-fc6d-4116-91f2-9d5247f8c094", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f81a96-eed8-4d81-9fd5-c3eb8798466e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893409ef-a1dd-4b94-9b09-619388f679b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e278e4f6-f1f9-4015-b247-f5b59772a3ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c6a9f76-7005-4990-993d-e83cad16f689", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb3196e8-0b37-4ccd-a256-216d44796681", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "362c449c-c93e-4357-a00c-ed9a51bdd083", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462bbde0-5c6b-44e5-b554-d907ff9f8b87", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfaaf19a-d212-4b4c-be6d-94e2d46deb96", "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": "3658c7d0-9cc1-4b84-b0d6-dcf768237a63", "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": "f60cd7b8-542f-4a1d-b36c-5223124be2ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce58d843-fd66-4373-b958-f9eaa48aca70", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab31e44-8136-4f8e-a4a1-17bdb1bacc26", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bccb8ae9-e12e-4618-94c7-a051ae319245", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db335ce6-6be7-48bc-af6a-d74d30d249bb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7b2141-a533-4924-8cd9-48cdc5f9353f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61e7046b-6f5d-4725-85d3-7b14d59bd249", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9755f1eb-0917-4f27-9a15-41b48bc7cabd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "667c1669-ff43-44fa-aac8-1ad0e478779e", "name": "Update an Order", "request": { "name": "Update an Order", "description": { "content": "Updates an Order", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "external_create_user", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "promo_codes", "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": "a9c6d030-cb75-4c1a-9c33-676940288cf5", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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": "437ee6ad-627c-4584-bfc8-51f64fc6faec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "019d04f0-5599-4412-864b-9d8a9c362ef2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37f6655e-0c8d-4e12-84dd-0914d255966e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f6b3d60-e524-468b-afe2-ba23c70051fb", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34f99d5b-ebbb-4682-a750-7af71e4ebf29", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "802c55c9-0330-4892-b603-1cf4c294f269", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ff80f6-dda6-4b5d-a202-b3ba6badc9ec", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7db0e944-ba1b-4db9-8930-5ffd09b19b6c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "promo_codes" }, { "key": "update_mask", "value": "external_create_user" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec5fd780-0cf4-4f34-a667-f8500b3aa2d1", "name": "Update a Payment", "request": { "name": "Update a Payment", "description": { "content": "Updates a payment record with external source information and status", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "external_update_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "external_source", "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "286ad6d8-e417-45c1-a272-90de5a417a81", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\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": "92fd1a05-9714-4ce3-a5ec-94f08680295c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328da723-5598-4a1e-a14d-4133d3ad6a4d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83e229df-1dc4-4159-b656-897ea2867e96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07de0e15-b1c9-4909-afec-4d11a556a831", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "336eff7f-1d21-4b00-88d8-1229b548c1e5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b43577-2da9-4538-8b98-51faffaf634f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26134a2a-54d8-4f50-a2bb-1a122642316e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53bbe56-d51d-453d-8bc3-daea1b68571a", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "payments", ":payment_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "payment_time" }, { "key": "update_mask", "value": "external_update_time" } ], "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\": 8966.363972227611\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19be44ed-f2ae-47d2-b6f8-02f3cb9121a9", "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": "ec28837a-b763-47ec-9f77-7c2fb609f05b", "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": "5c637a2f-74a0-4f22-9dcb-527c005fc0a2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfc440ff-314e-4b4d-bcdf-c956114b88a4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d503471-7d9b-4eed-a775-e533cbcdc47b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775a5562-dd72-4118-bf5a-e5cc45dbf17c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a854df16-5df0-4b44-b369-a8088d9f0145", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c6b5cbf-32ca-4a3a-a73b-7e1a62ee9a76", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d3bbbd5-e7c3-4eda-9e94-f8e1854a8642", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5651ae2d-e8fa-42e2-ba9c-35d88c676727", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e038fcd-b93b-4d54-81eb-4fdc81d2073b", "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": "6b43b1df-0b3f-48bf-9e83-8f9e4e2a300e", "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": "f555ebd3-a76b-4ddd-a60b-30f99642aebd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb3fe8ff-275a-4a0a-9bbf-0d48b5274749", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be7d443a-fc98-4772-80d2-4b477687379d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26c62a6b-c211-4e79-82d3-e074baf9f090", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d2338e1-9ca2-478d-8417-b0d9bc6199ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62909a2d-053a-4724-9c3d-1c270e18ab6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c07512d0-ad6d-47d2-82c0-e22b8f3b5e1b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa345b29-1075-4437-bf36-bdbcac611517", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11044cb2-fca8-4f69-9395-237d4e304a78", "name": "Update an Order Item", "request": { "name": "Update an Order Item", "description": { "content": "Updates an Order Item", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "subscription_plan_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": "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": "92a15ff2-cb2a-4a71-a54d-b1ac4cce8d43", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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": "f2b332f9-22e5-4a15-836a-2d7b636beb78", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cdb7c9-bedf-4176-9b04-13ddc7cd2275", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274fb436-1d25-4d0c-8253-0c94e03af524", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76baaac1-8953-4449-927d-e8568900f066", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "525d9953-a0d5-43e8-bc59-52890512a1b4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19f9195c-baad-4ad0-ac06-c23e8b4969f9", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56682471-9c88-4404-8d01-7957e98764e2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0e4fbc4-5319-4e3b-b887-4f12e28d5a20", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", ":order_id", "items", ":order_item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "cost_per_unit" }, { "key": "update_mask", "value": "name" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c982f6a8-044b-414b-a306-11ac373d524d", "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": "1637f23d-3d70-4b71-b184-1e1cefc79225", "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": "b41efbe2-938f-49df-ad17-3e24b62505d9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb3a3fe-2995-4201-b874-6c7361941f7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e45714-4388-4d85-b56e-297e2dc9460e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c23d8e-7bd5-4b26-a4f8-d11db9793e6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d80e43a7-0fbf-4c3d-89a0-a669704348ca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c062b03e-1f57-4093-988d-028e37d279e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11debaf9-29cb-4e05-9046-397676abd780", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7a340f-36c7-40f4-949a-1fa73bf5f3db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e272a12-1ee8-4437-9ac5-8a7df76b2e3c", "name": "Update an Order Custom Field", "request": { "name": "Update an Order Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Order object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "07a902ac-d5d5-494e-b84d-c541309d7be2", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55f09e02-570a-417b-a10b-62612e4f25e2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdfb11e8-02c9-45ac-8770-8543fc74477f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5da6c7c-8f30-40f3-be76-11f8f1832760", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d29ce276-ecd6-4e42-8fb5-2a2f0f57e8cf", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe17103-276a-43ae-8898-80e029d91efe", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "122d21b9-43f0-4f9c-88ce-f3f64c9943d1", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a39dcf8-f33b-48ca-a353-eb72c7e53c44", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96bfeb8f-cf2c-4b8e-bc99-9d488f48ca81", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "473949c4-0c8f-4bb3-9151-1e72a530b49b", "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": "04f54f02-3f35-4516-9424-750920be1bfa", "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": "5d32667d-2aca-45c1-9074-0a39beefd824", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b09608c-b7c2-45cb-80a2-87894387b44a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64e1a845-c71a-416e-8714-e7f891e44671", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a6ccfa-a127-4b14-b10e-6e87942aade9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81538604-17cf-41f9-b2b5-d9433f7d9e91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a0ec6ae-f13b-4120-a4a2-6d555d8f1eb4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86a3d28-45aa-4f92-9b6e-2478736be42f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af59542c-579d-452d-9f29-56569f0e7a93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cb97691-61b1-4993-89b5-375944c3eb60", "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": "e69355ee-d7c9-4e53-beea-a70cdf258458", "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": "518be66c-34cf-437d-820e-3a98e993e938", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81bdd8ce-8a81-44ab-8cbd-8a152f90da7e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f73ec07-79de-4c59-b680-b8b9f7639f8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0ac206e-552a-4549-8887-5c5051f969af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "054487b0-4e30-4cd4-ba30-30fef4725424", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca4eab15-021c-46b5-a7fc-045d5d4278c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cf2206f-1ebb-489a-bae2-671cecaa25b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c09b977c-1ed2-4337-bf6d-7c7f5942a4be", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06b7bca1-6dff-4d75-9169-f01cebc9d40d", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c14e6a4-d9e9-48fa-975b-3b73b4bb2de7", "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\": 2647\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": "1d78f56e-7e29-4e72-b1c5-e0fc07dae1e5", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89a9cb77-a304-4c30-a171-868eac8c7876", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cabf6092-94d1-4384-b50a-49eeb0c16a14", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c6a1672-4368-40e5-8493-36b24f0e2572", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "637a867a-0ddd-49fd-8fff-7826a1432007", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fdda46c-4836-42be-903e-0de23f6348c2", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc6beb71-ec46-45b7-8cf7-06936e654713", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343bae57-0c03-4087-903f-07755460fd1b", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2410e548-920a-4112-8964-71f4e26f32f5", "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": "38a3b747-368b-4a3d-a09e-69ef5c2856e1", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45c143e8-5fd0-4dd8-a236-3ce213bd9e36", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afbf8455-e209-41f8-90fb-4e8377d3f55d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3812daf-9905-4da5-9e96-04d103612a30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a275413f-1733-413b-b087-ab8b85c5d0c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8259cea-aee3-4782-958b-6aaadebe1f02", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "585e12ba-e63f-45d4-a8be-c0e4933f80f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29859517-f18a-4622-84b2-0706e8793f5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e5c709c-772d-4a92-81c3-09b56e9b308e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85de4992-e3e6-46f3-b777-47810b1b6c08", "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": "9c21286e-ce1c-4a4b-9cfb-a9a327d94eda", "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": "e92a7166-9710-4567-b551-941beb96aea7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a35a7fa-5769-4caf-aaef-ae3bda8b3b73", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf8e4e6f-af92-48c1-9244-9d8933bee02f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6302790-3f3e-4550-9273-67222d570250", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ade2f324-e7e5-43aa-885e-ed78a28f3029", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1533798c-4550-41c0-9a5d-bfbf0d360933", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b859ee5-5309-45be-8550-88f50c009872", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688d79bd-f40d-4054-b221-317534dd1271", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "806230ca-c303-4ec2-a960-2b4d3663ebda", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e6f14bd-af57-48cb-8ce8-e018660d0a25", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79ef3233-4cc8-42f0-af70-177d277bf5b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720f6581-0718-4452-84c6-8eee9f552fbc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2af3fcb4-0709-4229-9d1a-3a379d85cb01", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "328c2d11-0b06-4df9-8ff3-e66adfe12af2", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc4e1a3d-13ea-4e7c-841b-338105af1b66", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c0cff69-5adf-492f-a3e3-c1d654895733", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa27345-43d9-4ba1-b979-4ae3f9d81c22", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a262551-ddbc-4c4e-bcc7-897c228af73b", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "orders", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "999319c7-7efe-4dee-86ba-3e90a3754065", "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": "a872a360-df27-448d-85dd-f5a99f3dd9ee", "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": "941ce160-2893-4efe-a34f-665ffe0ae3c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f420fa-c61d-457a-aab5-ef64a4132ac3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d02fc05-9e8e-4140-af89-8b0f28a34aee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf620802-2c37-44fe-9dcd-9e274ae241af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa7115d7-55e8-4fa1-b424-a3b0085f3ee0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3002c470-9427-41a6-8b72-78762cb2f832", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12a9b046-9588-42a9-a108-91ee11a2d4cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9eefff-e132-4070-9a62-bcdb044d03dd", "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\": 5119,\n \"message\": \"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": "3515bb54-d5f4-41d8-ae6e-f5cc04cbc35a", "name": "Payment Method Configs", "description": { "content": "Payment Method Configs endpoints.", "type": "text/plain" }, "item": [ { "id": "97efed8b-1512-4e8a-a98c-a57898cb3e11", "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": "3eb16a92-a2da-4d93-b79e-1ca7f4ab9bb1", "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": "7747fa6e-d678-4c09-95e7-20d7f4e98cd1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c7167ac-3575-438d-8e82-2754f4c558ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44243c53-10ff-412e-8e88-1d1fa3ead79f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a330cc06-f9d4-4c80-ac7d-e46e7a597836", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c9a5761-8875-4801-a2cd-3f9f307b4c43", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52099318-7348-45f8-a500-ad9344a5e586", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18e8744f-5b5e-4a05-84d2-24538a397fce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c68159c6-91a5-438f-9bb7-804a3512e5c8", "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\": 5119,\n \"message\": \"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": "4d0cddb1-e2bd-4385-b469-c8151447355c", "name": "Payment Methods", "description": { "content": "Payment Methods endpoints.", "type": "text/plain" }, "item": [ { "id": "7757e4d6-9634-4b3e-ba5b-ddfdf93fb72d", "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": "afc989cf-1bcb-42fd-a1dc-bde6f10ee610", "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": "12941dd1-4b5b-4f0f-acba-7a222f20b5e9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8023d23b-5c82-4e93-92d7-8da28c5f8b95", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee247e9-16dc-43c0-bac7-b63ae1d31daf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe4a0c7-290b-47d7-b0e4-0dda84e2800f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351ac4f4-1d33-4cee-8d2b-76cf8c374f5c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "778e211b-80d1-482f-a15a-4b9dd4fa99e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c220d51-a418-4632-a8d7-facdeb1ff02f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f11eac-a35c-4e0a-8a66-83c5925c98bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "beffe1dd-7027-4617-97c0-1f6cf5e13602", "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": "ecf71e82-df94-4e7a-9600-f622c5a1c68d", "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": "607f4dd7-e2ec-4139-9cc5-c3d0e676f65b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7720055c-0df7-4b16-92ef-437fb6386939", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b75f53d3-42e6-4104-ae0e-510e28193039", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "832b8ef2-5e1e-4762-abb3-6d8b1187ed73", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d1ad6f6-cef4-41dc-a4b0-8ce69670af9d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c731c6b7-64bf-42ae-bf43-784a181614ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e42ec924-2a54-407d-bc3c-8ca8235290a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "647ee861-db60-48c7-899e-505d16e701c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fc19c2e-b248-414a-9bb0-b43dd50e6598", "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": "990bb719-f4d2-4541-83ad-813daa140c29", "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": "f1eef1a8-ca42-4826-aeec-76d5d213dbe8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ab4ab5-cd8d-41dc-9614-fa6064efb3f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfca083b-613f-483a-9284-633829f6dbd9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c56dbfc-cb4e-4fa3-a287-b0e96dcb2b56", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cdad9b6-0bc6-40fc-b0b5-26e2fcf5b0cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da198598-fa1a-4477-a042-fc1fd8125f60", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cd12478-0eb8-4968-9bb1-432e5fb1eb17", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78817159-1e7b-49f6-983f-7e798cfe88e8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82b43e65-5248-4145-9ef2-cfb3708c0871", "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": "73c51770-1482-407a-be3f-31fee4c6bd52", "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": "8fc35161-f373-4296-bbe0-b477e364b4b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13e88d5b-568a-4b23-90a0-58238ae6aa31", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c3e321-b967-430d-9c3a-1a1a0e8b4ae6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ca409e-3432-4775-b69b-6f8f8f556dd8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90aa3668-1d45-4bcd-83e2-3d65294a8f88", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c849a42-e21d-4235-95eb-69b2847c5545", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e08a15d-33fc-4686-b07a-5a34db0e8cf9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a25b30-814c-4441-969b-aa6a94d70508", "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\": 5119,\n \"message\": \"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": "d468f1ab-c504-4ad3-a127-35dc40a2e5c4", "name": "Product Categories", "description": { "content": "Product Categories endpoints.", "type": "text/plain" }, "item": [ { "id": "51d11aa1-22c3-4dc9-bca1-438cca606371", "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": "a72d2cfc-8f3e-476b-a3d8-9043793245c5", "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": "2ae31fd6-28b9-4fd7-ba94-272155eea2cd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced541e9-56fa-4104-b512-39783a003938", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4330f171-4709-442e-a871-3aa558b8be8f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ad01fa-cdd8-4e5f-944b-dd6a474d4f93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9138ad61-b186-4c41-a392-b84f5dba3522", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "706489d0-ccb9-482a-a075-b118abdf7273", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f16fc836-1fd7-45d6-ad58-8ba950bc1fff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee7e5296-8b78-4657-afb1-c0fd1e2f3a05", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b442d000-7d1a-40eb-8d18-96168a79a422", "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": "8f356b9d-9493-4eae-85ca-862b16905b84", "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": "3455c9b7-d850-405d-9c6e-c11a8e225f3f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b919496-8ae7-4539-81d9-be192dd338f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff926299-ee9e-4ab0-badf-a3b86f8eb921", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "260c10e2-eb0d-4321-9ad6-6f96f7d0191d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e990b730-1b2e-46e8-92cc-62f1a9d0d99b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65f4599f-275f-45fe-a890-e5be706e24b9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7eec31f-a16b-4504-8d9e-23c4fd045c16", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b00c4c-d1ab-4272-810b-31af0990e8ce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "887bd41b-fb9b-4fcc-935e-b8b93a1fba35", "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": "70844533-1de9-4bd8-9090-a6ab4a1c8eab", "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": "c50d489b-56d3-4fb2-801f-a93cafec634a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b0d46f9-da58-40c0-94fd-c75b17950776", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b169065-ecf6-4102-8376-66a7e8046210", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcfe6ce3-c843-4c79-bbc3-3993d5d1826b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f1936e4-a512-4c13-bd17-8c9320a55b1a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75441f3-33ba-4e3a-a03c-8915ccd341d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f071129d-17e9-4c8a-afbf-166ba33cdba5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f6fc600-5f85-4d52-9aba-ec0e1de3b12e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfeab913-7a6c-4345-b744-152c8d38e4d7", "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": "6e1c196b-e7ae-43d1-ba2b-93d48696bd1e", "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": "9bf6545e-cd25-47fe-86f3-40a99ee14053", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023659b4-ffaa-41eb-8bda-fdbfd9f46c00", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82522221-17e0-4440-860b-8d91bd388565", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52461739-4f06-4d4f-8b17-a7e9e84ee5ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce01eeb5-c071-4d2c-a3bb-82dbc3999512", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f9f355f-5a63-49cd-87bb-802fdc9ad09f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fef87da-0e7c-49eb-9d13-b5e42f525332", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51182a19-b3b8-490b-a3de-d9f3eaae1e17", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42763914-7ff0-4f38-ac0b-cc77a491d9cc", "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": "4161d35f-416b-4242-a854-745b3e8c5cde", "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": "76fed0fa-026b-4d31-baeb-5ba7d87655ba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "651401d4-abe0-4ba9-900a-719b03f53b2e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e783813-f0e5-4743-a84a-f2556bd38b91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c99d7936-1a75-4d46-99aa-01602b3d6487", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121110ca-06a1-4243-9ad7-4639ba564181", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea5b1043-a4c8-4c07-bad2-d82196f8fe04", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a52e5fcc-1dc8-4f35-bf37-99251ba5e27d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a35af00-3cfd-4078-9e19-f589f9b46c49", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fc5c4bf-6606-428e-918e-a68ddfa91567", "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": "dd119694-303d-4782-b2bf-b990fe8df1cb", "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": "2d486b9b-2880-48bf-88db-f54f2c6fc0ac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec62297-97c1-4c9c-8e55-d07690942b15", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b756fc-f548-4655-9149-2c3fafe6b1d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98bbb8b2-37ea-4ba6-b1dc-35f58015dd5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a325dcea-de90-4a43-acec-f1c5a3cd42ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb52d6dd-9eb9-40df-8041-d888f57b98bb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c78ea589-e65c-432f-b0b0-4b7e1870873a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a05ad9-c3b5-4d18-8dc6-a0a2d80c1f16", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4404316-074f-4509-bed4-d78b8a38c197", "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": "2eb6f346-9f76-42d8-b88a-cd5a78d98d32", "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": "851b4609-71c5-475b-a2fb-0afe37b65717", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8632d7a-3422-42f8-820f-b9b9de2905f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a92619-8b73-429c-ae05-843371e6b7c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e44893a-5e92-4e69-8b8a-a7be565e7f75", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "733a0701-288f-4879-ba3e-7a73c8a0a829", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74021222-dfe0-4b53-8825-f6923da1d3de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49a48ac6-0303-4448-b010-813444734987", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca5e2a30-a989-40dd-9f7b-cbd532d4da7b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87b5e430-051c-418c-bfce-0813c7c014f4", "name": "Update a Product Category", "request": { "name": "Update a Product Category", "description": { "content": "Updates a single Product Category", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "display_order_index", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89338fc8-06ec-4c9e-b424-504a1f714207", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ae17db5-3568-4f3f-b07d-532cd34810ec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40cd7b7c-45d8-43a1-abae-81541c81a82c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b427afb-62fa-4d17-863c-75be6c927805", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870e3f5c-be77-41c4-9bc3-b8dbc708c9a0", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9db6956d-8925-4b9f-a2fe-6cee5ed680ce", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9bed2aa-3fdb-4a2c-aaeb-3b0fdfe210b8", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0a6627-ae78-41ca-ab78-f70ded86e775", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453e71e4-c8eb-4e04-8986-dbac10db7d20", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productCategories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "parent_category_id" }, { "key": "update_mask", "value": "display_order_index" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Electronics\",\n \"display_order_index\": 0,\n \"parent_category_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44e9a65b-2bff-48f1-8c04-4477f98d3a08", "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": "1f6ce8a0-c919-4286-a032-b40f5a8153c6", "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": "7a86ccd0-a59d-4d33-b320-f8c29497b604", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9e3a19c-5574-4640-ab0f-a4a1f29f84bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f484fff-40f7-4474-b430-017f9b010fb8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7da3802-ccd6-469c-9f67-6b3fc2bf12da", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2cc2a3f-975c-46e7-aec8-86da05bcc646", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e67ddf-0096-4bac-923b-341cac0ab581", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1131827a-a118-4b10-bf19-647642e31efd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5483c8cf-e584-4580-ae21-44aef583f59d", "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\": 5119,\n \"message\": \"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": "1692d2fb-2f82-4d03-834f-f45a45f9653e", "name": "Product Discounts", "description": { "content": "Product Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "ce1ff5c4-4d7e-40ed-94dc-3957b61bcb82", "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": "7fd1697e-a141-4b63-9498-52dbcdb62310", "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": "349c1bca-ebc7-4c5e-ba09-a27d3919cd8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9570e3-5f4f-40aa-bf19-50bdc3244b1d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16f9156b-862b-4c07-801e-9d47eaca1df8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c72c7ca2-d6c4-477e-b6d5-a2c9cce4e2d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14d08bc9-2b62-4010-8aac-ccae3998fcc6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb74451-614a-4186-80bc-edb53af2f652", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b8162ec-ca4e-4a7e-a4e9-1e7f6083acc0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "decf605f-5427-4cc4-af6d-28d3b054446c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2037041-708c-4409-b263-344624e028c8", "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": "28574eeb-4e3c-4504-86d1-e1494c332f08", "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": "de4d6cbe-9db4-4a6d-ad32-2ef7c82baf97", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac1cb6ec-8876-4054-87cc-aa601f2a6454", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a62aecd-9067-43ca-a63a-0ac794f09f38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9453d89-e9e7-4994-ab8a-f4dfcb3214a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5ddc0ee-8f63-4412-99cb-7105efc91ce2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "558eeeeb-31d0-47b6-bb6b-1d547931d4ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69191be4-9c0c-445b-b450-0819a03f7ed0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc46bbd-f1b6-4f43-bc76-92300dd8a13d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b84020d-edd8-4f2b-956f-1d4b32f723cc", "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": "a62382c0-06cb-4803-9cf1-8ebcfbf073c8", "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": "ec1d09ad-36ca-4a41-b081-b444ac170e7d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c6e0cc8-e02e-4b9f-9928-25a2b043529c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6dfb2d-0c79-4752-bc91-24e1ed95314f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a0f049-44ae-4be2-a092-76c0a768abb7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8e42d05-3008-4df7-8996-fcbac4843539", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb7f3c9-aa7e-4474-b26b-5d35ce580de4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a3dd31-4392-4e86-9db8-392c375e8cf7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "554027f5-793b-4b4e-99e2-915404faa22c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "affd07d2-d065-4900-8d3b-4c65a498707c", "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": "91f6709e-754b-4380-97f3-aa230e175db3", "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": "b018eacc-767b-4f42-86c7-a57da55e35de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222e61c8-c3e1-4059-b76b-429e72ced1c0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2512f61f-c3ed-40db-97d3-bd08b17f74bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aff9e36-a383-44d0-87dc-1b5c494117db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7544599-4f0e-4c75-8561-5d433a4ec34e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85dbc6c1-8cfd-4981-bdc0-d3685869dbc0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d913ef21-7dcd-4a36-a4fa-02ec7f2046e0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7868b3a5-5e8a-49dd-8a91-aa7962d08f81", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a335c679-6e18-4edf-852f-7ca0e5b2e154", "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": "1a387a80-0087-40be-a3ef-ab4c7b82b5da", "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": "d4376c7f-c9ae-4427-9f59-216a75d53d5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e18dbaf-4256-4407-a4f0-2a543b84c448", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be9c37f-baed-4d41-9c0c-253346f91e88", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907b3b71-78a8-410b-a260-2236343f7977", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8637bc1b-2159-4f91-b688-cd2fe2fd67c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046fdc21-28cf-4177-9912-d581c9a71034", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb47cd86-3dbc-498a-9fb5-d84157015054", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25acb577-25f9-4db9-9107-dbbb097e6741", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45c4355b-d085-448b-94cc-fc5ff779a697", "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": "criteria", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "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": "3e63d170-3406-4193-a74e-285554e14011", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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": "ff151e73-5f7f-4ee1-a930-64856c631a20", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e914be-2073-40a1-aded-81c13e30ed98", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d48f686-0366-4d00-9236-95f62506b8a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6256c868-0a05-469d-81d1-b52cfa769337", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "714eba22-5afd-4a0b-baf9-e8a5b447ea67", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ade3d4e4-d79b-442f-b1a5-7119f74f4e4a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b25991f6-80d2-4c2a-a6f0-5d006bdc296e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc6c3e3-7132-446f-802b-61e4db20bd98", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "products", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "product_id" }, { "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7750086-b16a-46ef-be4d-8c15a76c53a6", "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": "06030524-ce18-4c4e-801e-a0734ddeef9a", "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": "5ce6f1ef-7ba2-494d-a3ed-2a3a27c4659b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b24c83-663c-4425-a115-16936648391d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9608e35-f5b0-403c-a879-8b642841ec68", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893d646e-b204-40bc-b4dd-5b56df081251", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ac2af2-3ce9-4337-89b7-9c1ba5409680", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f35293fd-a92f-4d23-b643-8a3094fec70d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c77d3633-36c8-4e25-99c7-b821d34e0348", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a082c82b-128b-43e0-90bf-a456db811149", "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\": 5119,\n \"message\": \"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": "60c9626c-16e1-4796-aeb8-99135b643724", "name": "Product Interest Bundles", "description": { "content": "Product Interest Bundles endpoints.", "type": "text/plain" }, "item": [ { "id": "fc9e8e4b-157a-46b0-a0e9-6ad20515426d", "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": "ca2b49d2-695b-4411-881d-648ab793934e", "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": "1a415162-7e2f-4dc5-870b-97be975f7f05", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d5fe650-9a95-4f50-b5f5-376d36c59e28", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b08e5a56-c43e-4379-84c9-d48d7351518c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9924b70-199b-41f4-962b-b907b76b5aab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89dc3094-1cf3-46a4-be6b-1908a0c0f6f7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c194e72-9e3e-481d-9779-4d07cde3f824", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a010896e-6770-4672-a72d-5528a6abedf9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08549d00-9efe-46b2-8c26-bcc7ef45cbea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7f6c610-8012-40c4-abe9-ae57a159738f", "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": "6aa857fd-fcfb-4ace-8359-b2d54f93bc4d", "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": "94f55671-35ce-43b5-a57a-172169c9962c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "199c9257-80fb-41f1-9561-34f8824e576c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e779567c-0aa3-44c5-bd90-5435224a9951", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20806bbc-f227-4f97-ac93-9002c7775545", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaca1c1a-12ae-462f-a742-19920d46bdb5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1fd6f1b-53da-4248-905e-acdb57f3adc5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41c23728-5b9b-4d30-bee1-e59a72a5dccc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "209defa6-889f-46f5-975b-8697908f475d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e68b60eb-b55f-469b-ad9d-ae68036e0e77", "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": "1a572812-6909-4415-bed0-4eb97dc5ce75", "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": "c3735fc1-6308-4bed-acd2-230c045f1d87", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "190b9f72-442f-49d2-9b72-d5e0628dc430", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8702b5a-9c6e-497c-8188-ef549846d0a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcdd9034-a46f-4b57-97ca-8fbcf5a1485a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "034f7751-1c48-454b-9cb7-7181be620315", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7dd595c-851d-40fc-8119-c932daaefeb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc89a53c-0c5a-4cc8-bc76-c97052a2d7b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de07a887-51b6-4f6a-bb1f-f73ec0bb2e6e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69bbafd9-7ae7-4203-9e8f-2e1061af3226", "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": "410df07d-b25f-4e5e-81e7-e562bcadbec6", "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": "e15cccaa-30a9-489c-a502-81eb0c84754e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fda46d59-66fe-454b-b311-24bcf6f279c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35fa5648-d3a1-4171-afe1-481804bbcc66", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef47391f-1dcb-4cee-a4e8-fb2f56859d54", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bef63a4-6d97-41f6-b685-ead3c6c54dce", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65ad7702-0c4d-4be7-8303-409e81e5305e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1cd18fe-dc7a-4823-8255-b9d06c96269c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63feeecc-af3d-45c0-b379-233e46f2a5bb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79c9418c-ffb9-4fbb-a7bf-552dae00d342", "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": "38e06766-354b-4543-a880-62793f35ff11", "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": "5e044d21-ddd8-4b8d-8e16-dadeea9823c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70056d1b-9f0e-4934-8de3-c89cd4906cdb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55145be8-3ce4-4b11-a685-96a302c36d33", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bde59ca-c958-4973-b0ea-2eb8253e66df", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f46ad6c8-ec30-4303-b54a-cb0520a04231", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f899708-4a6a-494e-a0cd-4dbfffa2c869", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6003f1f-d3d8-4e1c-80b8-9ebd4b7061c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f79d99-6933-4a1f-9766-27d9806724f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "029899f8-4ee7-4cbd-9cca-e27e8603f5b9", "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": "3afc7f8d-00de-46bf-9847-1a0e6c603e32", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\",\n \"product_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscription_plan_interests\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db835c1c-a952-4714-bc19-145402174d15", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce50ec53-f7d0-48e3-a799-9c2127b2c4d0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fa4a70b-b61b-4aa7-84c9-1213a1a9500f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46288966-ed0a-4dd9-a1de-d60a87536e54", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd8df87-a319-4315-93b0-8af5050297cb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c74d474-9274-4475-872a-0561e784bf78", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1db3dea8-b39d-4dd7-8e30-c2669b4cf076", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0808d71a-d686-4687-928e-e0df54724fa2", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Bundle\",\n \"description\": \"Bundle of premium products\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8bc2c7de-5c9a-477d-ad47-173837214fde", "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": "b8fa8cbd-52bd-4351-b0e0-2fdaf7269f07", "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": "659cfdbc-a6e9-4dbe-8e5c-0cf831f9854f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6e3bf8-3e42-4e74-a1cb-e59c16fd179f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a3c5a2a-354d-4c97-9df1-d64bbfb988a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408b2986-a8ef-42a4-bd25-7f7e3bdb5d18", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a208107-ea80-48ec-a416-3602e74d45d9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e3a9a7-634e-4950-8056-738ed25a49d3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780240ef-91d0-47f2-bf09-6e2dd6c2f676", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24603e49-e016-4aee-9853-1845eae8e0d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4860e55a-bf70-4582-a90b-4ab2b7f16efa", "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": "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": "discount_percent", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "string", "key": "interest_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"price\": 10000,\n \"quantity\": 1,\n \"discount_percent\": 10\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aef9b32e-9d94-444c-ad4e-d5bcfac8934d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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": "677433bb-7f17-470b-a29c-4e32e98d04e9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fd9efff-cbc7-49d6-b0c0-98464194a4ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1893ec5a-786a-4123-b91f-f933c661383f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ffa12e6-3bbc-40c5-a73d-0af2f0a94d12", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e48a65-8336-4337-b076-bb9f56e3897a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f3bf058-a785-4d01-b5b6-4632a129b4bd", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91b07ea8-c5ce-4338-bce4-37d3aa26fcb3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13bd8c36-930f-4335-a0d2-a63739d81817", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "productInterestBundles", ":id", "interests", ":interest_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "price" }, { "key": "update_mask", "value": "discount_percent" } ], "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\": 5119,\n \"message\": \"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": "8e2515cb-a114-4f77-8a89-502f5362170d", "name": "Products", "description": { "content": "Products endpoints.", "type": "text/plain" }, "item": [ { "id": "99dedb83-5f06-4be7-885f-0a44b29a393e", "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": "f8d22962-d25d-4315-b7d3-d83b143f6e6d", "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": "0edc0dd8-ad13-436d-aadf-79bcf43ad3ba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70fbd04-0304-4b7e-8e3b-e28ff615004f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eec753f-7223-4ef1-a770-17898ee50800", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e2b01c7-034c-4dd6-97ac-4780e457755f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca25120-9563-40ea-b9bd-48d0c88bff0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "383e6322-5e0b-46e4-8e62-f92160128314", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b960cfa8-4c9d-49b2-8a74-2fb17815351c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eadf7d8-ef59-48c0-a091-9db0c91f2b94", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "071ce505-c7e9-42ca-a33a-a38151afc07d", "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": "9bb4a504-3e9e-4d94-850e-07b0eb1fc4dc", "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\": false,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13814da6-fdd0-4e75-833a-28568498f3ba", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb6c8a7-0938-465f-ba66-2df541e7272f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba575cdd-ab10-458e-9039-839848f012c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791f799b-b360-497f-863b-791388998ee9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2e3d261-49f9-4e2a-a91e-545756a68586", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "753c09c1-12d5-40dd-baa1-20056fd611e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d079ebb-dc8d-4de8-bef3-f11a7d2eb891", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716cc3f9-37a6-4af1-8049-5fb841af1312", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f801079a-2e24-4128-99ff-66f6e578881e", "name": "Adjust Inventory of a Product", "request": { "name": "Adjust Inventory of a Product", "description": { "content": "Increase or decrease the quantity of the Product", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f85dcca2-1799-444b-9e89-646d8a216131", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4696782a-2b27-48dc-bebd-8a491bdf5e66", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138ccd6b-4d58-463a-96ec-ed19d4cf7a24", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79bf006e-42fc-4362-af41-ce16a5ac0821", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1965fc69-17ab-4ca6-8e5d-4d37bc043979", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64fe8cce-3b78-4dfb-a89f-9778050538b9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6cc71c7-58c6-408c-9aef-249cda7b3ff5", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3998c85a-cc4e-45f6-a446-f94806650244", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e7ebdf8-ad16-47f7-ba20-20de364dda57", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", "{{product_id}}:adjustInventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INCREASE\",\n \"quantity\": 3071\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0529978-e787-425b-9f8b-400e2c5f54c7", "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": "9169cbc4-ec63-4995-8a5b-96d0edb56261", "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": "7cb9b9ad-eea9-4126-9536-5461a3cc99ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bf263db-c7f7-419f-bdbb-2c66b413e032", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbac7587-6ccf-47f7-af11-92c402258adc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f9d6372-9f3b-4ce2-b016-d47005bf79b5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "346d4657-5b60-45a4-a793-d61ec32753db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0a00fad-7d2b-4927-a672-63a43f0e0e13", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ffaadae-f3bb-47f5-8e60-02f60d3bea5f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ab62095-6a8c-43be-8a82-b9ef73114cb6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fa585ca-1f7e-4378-9e95-f96abd6babf0", "name": "Create a Product Option", "request": { "name": "Create a Product Option", "description": { "content": "Creates a new product option", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "products", ":product_id", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"option_type\": \"TEXT\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 9466,\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": "a9624018-aa05-4ac1-a348-f125278ad0c4", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": \"TEXT\",\n \"display_order\": 5626,\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": "5e24be60-5f7d-40db-86d6-44f1b7d92d61", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c504e208-2ce4-41cf-a41b-9fd580c7f2d6", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc92ceb3-2b0b-4156-bc75-641bd839f70f", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4ed76a-0acf-41b6-b90f-378287e860ef", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8949530a-1e9f-41c5-bbd5-d5a904ce904d", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2060b7-271c-4e68-ac5f-9bfd84fa9138", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a35a5e-78ff-4455-a45d-3eb28c66d204", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cae85b5-ab9e-45b1-ac0e-66fed7449198", "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\": \"LIST\",\n \"required\": false,\n \"option_label\": \"string\",\n \"display_order\": 3594,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5840a78e-d69f-407f-9d0b-e7a9f1a52e58", "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": "f2e6112c-abe7-4f9f-a123-b02fb9e73380", "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\": \"TEXT\",\n \"display_order\": 5626,\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": "1d35872e-e2d9-465f-951c-457a9c86f5ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cb6b046-8f55-47b8-8397-5a27d5e0eeb5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb48dd2f-6cb8-416a-9880-e312e8e1e145", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba4f1b90-e743-4147-9264-47b17a3ea831", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213259ba-fb4b-4c2b-b6ec-798678db9726", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1acd8b8-cf25-43cf-af50-d67e2f75c0ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94269b08-362f-49f0-8cdf-cfec209afae1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68825078-c03c-4478-839b-d3bf0ac07dc4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2381f587-0191-4d3c-9dd3-cbc36d6e0b49", "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": "true", "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": "342aebf5-cabe-4f3b-8a20-8a7cd95e7516", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "091a0b9c-eee2-4685-948d-55d7fbc01f0c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "legacy", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) The product ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The image file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3df2fa8-365d-4d9a-8b13-a47c13170d09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25a58aa8-bc55-4411-849c-578a7a449075", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a11166e-2af1-40db-b757-0be8e864060d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00767a15-4032-435d-ad10-d98b8096293c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75473ab4-14f8-48f6-9c44-3eb7098def03", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea2a8e5-8da9-4dab-a245-8a10658320f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d40e7d-b2d3-4b4c-a495-fba619e91994", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4bfeaf0-2f2a-4c85-8d0f-cd3872242d5b", "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": "26416732-e40d-463c-b9b9-dbb01016a5a9", "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": "01681afc-9f65-4104-862d-c8095613ac1d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d76c6c52-c221-47af-8177-f07516767c31", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64f49974-02d8-4534-ad04-238860ea6ccb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b10d667c-8a40-46d3-9038-96890fb62c87", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35b9fced-5f88-46d8-94a6-bb90f8cff758", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73fe4c59-b482-4fa5-96f8-5ad27726391b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63605c68-cff1-4e1d-81e3-8113d7bb3888", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038f044f-b154-4670-8ddb-bcf9a447c7ed", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f01f111-f756-4e47-bbcd-c5ac1015268d", "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": "17074285-4778-427d-b8cc-bbf87f197ceb", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b2ec59e-9e75-42ee-9cfc-0cec95926500", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "459874fa-10fa-4d00-88e4-c6454f9b692b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c3510f0-4503-4d38-bf69-f481273b0560", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "728ca017-45c2-4df6-aa37-dee8f78e9dcc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8cc5ca6-4db4-47a0-8c3d-83bee20a417f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c31b72be-662e-4cf0-b951-416007d25ef8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61ee7b4d-1afa-4814-acf8-803135599db3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408b5025-f30a-41ff-9945-bcbe49081e24", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "828bed92-e2ef-41bc-9206-58e62ced472a", "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": "50404c80-1b5f-4e80-b4ec-8d4fa50016a2", "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": "f2f52cf9-808b-4ddb-b850-fbcad6b47ea4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae197c60-2a92-41c5-bf09-3ba9753eaa19", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3cccd9e-9546-46ee-ae3e-5f5ef3f10344", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cf91f37-4d0a-4b27-8d0b-e691a75e3a48", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e1d75bb-d5e7-4a5d-8689-3ab603516f91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24b93b05-9876-465f-a324-4ff3a9b879d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3deb0e2f-4dae-431c-8939-14595289b369", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a5d768c-43e6-4313-876c-76de2a19cdff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d195972-854e-48d4-8e75-2a5fcf66ca71", "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": "inventory_limit", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a76b558-703d-4f0e-92c7-8b59e5d993d9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Premium Widget\",\n \"price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency_code\": {\n \"value\": \"\"\n },\n \"formatted_amount\": {\n \"value\": \"\"\n }\n },\n \"active\": true,\n \"description\": \"A high-quality widget for all your needs\",\n \"sku\": \"PROD-001\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"categories\": [\n \"string\",\n \"string\"\n ],\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventory\": {\n \"inventory_limit\": {\n \"value\": \"\"\n },\n \"inventory_count\": {\n \"value\": \"\"\n },\n \"out_of_stock_enabled\": {\n \"value\": \"\"\n },\n \"email_for_inventory_notifications\": {\n \"value\": \"\"\n }\n },\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"subscription_plans\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": false,\n \"needs_digital_delivery\": true,\n \"has_legacy_image\": false,\n \"delivery_description\": \"string\",\n \"create_time\": \"string\",\n \"update_time\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfbb820e-61bb-4779-bfba-8fda085a86b2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67fa5816-5d1c-437e-bc36-05312be3ce6a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b90024-8ba3-446e-bae6-9fac5be03dda", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "101cf796-6370-4d10-8bb8-fa8e037ae587", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b7b52f1-d57d-4eb8-b3ad-f0da91af4e21", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bd6fc10-729e-4984-8afb-55ab0495b99b", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d277181-0224-4a33-b228-da66e6e2a336", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b9cb135-4414-498a-8ff2-4d6873d40211", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "shippable" }, { "key": "update_mask", "value": "out_of_stock_enabled" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Premium Widget\",\n \"sku\": \"PROD-001\",\n \"price\": 1250,\n \"active\": true,\n \"description\": \"A high-quality widget\",\n \"shippable\": true,\n \"weight\": 2.5,\n \"taxable\": true,\n \"short_description\": \"Premium widget\",\n \"subscription_only\": false,\n \"storefront_hidden\": false,\n \"country_taxable\": false,\n \"state_taxable\": true,\n \"city_taxable\": false,\n \"inventory_limit\": 100,\n \"out_of_stock_enabled\": false,\n \"email_for_inventory_notifications\": \"notify@example.com\",\n \"top_html\": \"string\",\n \"bottom_html\": \"string\",\n \"is_package\": true,\n \"needs_digital_delivery\": false,\n \"delivery_description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65df75da-80e8-44c9-a3b2-b323f21a8e9e", "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": "48b346a1-bfd7-44dd-ae4f-897d8bf08ee7", "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\": \"TEXT\",\n \"display_order\": 5626,\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": "cf6b70c4-187e-43cc-9ad2-710b74d8a993", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdaf52aa-5873-45e8-85c4-18667aaa76fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abefa440-7533-4f71-ac62-0cb0503bb9a1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9efbe5de-8fd5-4a3b-9b78-978407a23c99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2275364a-2886-4807-8c5a-5b66bd9709b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecddc664-a540-48bb-a531-29eabf3c3c23", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134eeeff-89ba-4ff3-981b-8015f5e33d87", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca1a086c-3b98-4110-8a79-1c22938f4634", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "386953e2-8f12-429e-ab17-c6fef808fc27", "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": "a7381511-f8a8-406c-b487-88a2e6498745", "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": "b76e9973-ff46-41a5-a4e1-e3bf4df4a847", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55fa92bb-ef7b-41ce-94bf-44b7c6bc1f1b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99b84039-9719-4851-9520-4cb635b866f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa3d8c81-6ae5-414f-a7d3-5d5140888cb1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44387a2f-153a-4ea5-a611-31134af96d02", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb3795d-f272-4e11-a6d0-8695e0423348", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e67413a-1de8-46dc-aa27-ef772cb9d58e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d2711d7-e5dd-4717-833b-65027a1f2e35", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a58adb71-78a5-49f3-a180-ed57f77a3943", "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": "maximum_characters", "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\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "871cc84d-8f82-4825-a8c8-785f8c802278", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"required\": false,\n \"option_label\": \"string\",\n \"product_id\": \"string\",\n \"option_type\": \"TEXT\",\n \"display_order\": 5626,\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": "6f99fd16-5187-4901-b45c-726136c8ed31", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f877b3b6-6e35-4f3b-ba2d-e8cd3291561e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61126a59-6e62-412b-b837-25b277233ad9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac92e81-2381-4012-9dae-e337ff3afa37", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1eeedfa-3ef4-42a6-bd59-0fb95b34f9b8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4d5383-5cb9-4f89-90d6-fe5aec29f832", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "272b8a77-b3e3-47a9-85df-e59fa10fe932", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92951ff3-03c8-4c8a-b81b-a2d1c235ff1e", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "error_message" }, { "key": "update_mask", "value": "minimum_characters" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"required\": true,\n \"option_label\": \"string\",\n \"display_order\": 6313,\n \"minimum_characters\": 6660,\n \"maximum_characters\": 5537,\n \"allow_spaces\": true,\n \"only_starts_with\": \"BOTH\",\n \"only_ends_with\": \"NONE\",\n \"only_contains\": \"DIGIT\",\n \"error_message\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2071a228-df06-4f0c-b925-2528bf4be4d7", "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": "d900ba77-4e2f-4a8d-9591-788b0e52673c", "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": "ae7a693c-ce0a-46bd-8d4f-b1f872ba6122", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64153025-81df-4cbe-89b3-80617149f8b7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08fd1a7-8ad4-4a7c-98cd-1c48f241a5af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a90beb0e-f09c-4577-8b72-082a1420209e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a17fcd3-a95a-4e7f-ab91-45ac8ce789ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5caf1cf0-8736-4efc-9a1a-ce450393ed41", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2deeabd1-b77c-459f-b538-ae247c33755d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484310d8-a530-46b9-8c94-573fe5b47813", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bae8628-57d2-41a6-b55a-7bb5f97685b0", "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_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": "item_display_order", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "product_id", "description": "(Required) product_id" }, { "disabled": false, "type": "any", "value": "string", "key": "product_option_id", "description": "(Required) product_option_id" }, { "disabled": false, "type": "any", "value": "string", "key": "item_id", "description": "(Required) item_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_label\": \"string\",\n \"item_code\": \"string\",\n \"item_display_order\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f296ee1-79f0-4027-8776-e4aa559786e7", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\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\": \"TEXT\",\n \"display_order\": 5626,\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": "36b92df5-a570-412d-a4c3-73c8923ee8d0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a1a128-e8f6-4cf0-b37f-a86b0a815a5c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "479cd394-9e35-4d84-9f3d-410148fadb90", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea52a8c-688d-480f-a572-f0889fe30e84", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c0f525d-820c-4af0-a745-cdc0321042c4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "454ce921-86be-4047-84aa-d87c6765c008", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4681aac-634d-457e-84eb-db7de4a29d29", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5f3b428-25c5-4e93-ad06-31841574a8c4", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "options", ":product_option_id", "listItems", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "item_display_order" }, { "key": "update_mask", "value": "item_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" }, { "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\": 4982,\n \"price_adjustment\": 94.10025925230548\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "018880e5-58c1-4fbd-9134-44ea51ae8278", "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": "7cb17565-fcf4-40cc-b050-f874177ac3c2", "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": "039c666e-f795-4d4a-9860-66d6b90d81c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a4e612-91b3-418b-849c-302602907821", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ff1cca-2851-4c0c-b57b-8ccf9f23bc12", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14862d95-6af5-481c-8d97-48e886950c38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cb36794-8a1c-4aa6-bdf5-3fd15fa41917", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "012310bf-07ee-489a-aa23-05184f2b0a20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "701f7e01-3a07-494c-818a-0ef3d460b500", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "875af1f7-5970-4d3c-9411-5ac74e85ebf6", "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\": 5119,\n \"message\": \"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": "85c01cbc-8624-468c-8836-73bf000ea0ef", "name": "Referral", "description": { "content": "Referral endpoints.", "type": "text/plain" }, "item": [ { "id": "91618cd8-ff0f-4f9c-8eb9-17d2910d6cef", "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": "3771a7ce-2586-4ea3-af25-283d1e93eb5f", "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": "cf5c0e44-ddc7-4fa8-a5d4-0acb6a343b7d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "577ce28b-a2ed-4c51-82a5-8cdc7828b0a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfcd5512-b754-4f01-8be8-47483c813c6a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f06041f2-5fd4-46de-8299-23c98411d2c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa6410b-3b9f-4bd7-8434-7234bd5ebfb8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01d84534-95d2-48be-b764-cc10b26f56a7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66435694-6ac9-4730-8314-3d21b0371b6c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bd219fe-7f2f-4bf6-978a-6005717608f9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a930e71-1c66-4f24-89f6-3f1c3df40a24", "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": "8505e833-933c-4ce1-9c67-a40bdd5a8b0e", "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": "973431ac-9242-47d2-9d1d-b022b2d2d8db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "675879ce-f2e2-43e8-a1f4-189ec42ad6d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "213560f4-a243-496b-b8b8-dc5dda071f37", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf059c08-23b5-4657-a282-be8b6bdfe67c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df957b54-f38f-46be-8209-3f5765175b20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c786359-8cd7-408b-abb1-0b15952b9743", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad183f1-0121-407a-8afd-98837fa92b64", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65690b1b-4412-4b97-a181-ff75c8dadf1c", "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\": 5119,\n \"message\": \"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": "4c0f1066-b822-4811-bda6-e28b093b2d5e", "name": "Reporting", "description": { "content": "Reporting endpoints.", "type": "text/plain" }, "item": [ { "id": "5f1cc4cb-160f-437f-a51f-8ede8589bc47", "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": "8609", "description": "(Required) " }, { "disabled": false, "key": "fields", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "cefa8da2-d82a-4141-b78a-b354c2338fb3", "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": "8609" }, { "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": "aab02ec2-9ec3-470c-b6ad-7350c0391e06", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "482e7e7e-e640-4159-9fa9-27a665226ab4", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18ae9b76-9193-465d-bed1-bc6579e15b08", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90513e3-0a25-4aa2-b0b6-bcafd6f82995", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af6fde3f-e7ad-429a-b2c0-47989c97c956", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8d24640-8e58-4646-a92d-1c71d523e3ba", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbfabf34-451d-46ce-9482-79d67d60d6fa", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "885ae9d6-51b4-4f7b-9531-1be83694623d", "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": "8609" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9c8a77f-7a88-4a2c-b094-50850768b0b8", "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": "e3302cc4-ca9a-4ebf-8a56-639165ae5b10", "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": "6be2764f-1bc3-4665-9d65-821f58222be8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "071be2f6-56a0-4729-bc88-d80c43c88228", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b71e249-1d29-40ed-9954-2d891cdb8f0b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a94db51a-4f83-472e-a2b2-43851fe00b4c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a56d501-9f3e-43b1-8684-07ea6967faa8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbfe5c21-e869-4310-b351-dc66aeafe4f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e575f0c1-aae0-4f3e-89f5-8fb93f76d856", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea2b7cf-b704-4235-ac54-51d74ca5db83", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d8f96ce-51d1-4f1f-a983-3d3fc18faaab", "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": "2c7f90da-52ac-4f19-ba21-6810623c86cf", "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": "b758ee97-af1f-421b-81d9-f8f1e9315036", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8005385b-7d05-4568-9ffa-9662d3700629", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f7449f-ae09-449f-b044-5ef56a8d7155", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "329b2228-79df-482e-b9c3-b440438e64fc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad1377f3-a324-4059-b00b-025d16056e4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d22007-2dc5-4540-b58f-50dc8565438e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d36f21f8-1e7a-48f6-b590-d12b101a97bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b03b105-8c09-42ca-acdb-22aacd285901", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8070657d-a81e-4d57-88ef-c5f894afc532", "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": "8227aef4-89d6-4225-ae07-ff8e080103f5", "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": "837de996-5ace-4bef-b3bf-8c99cb928e38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f670185a-6a4d-4b63-8fca-3a1145ef2da3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f259a5-c7ce-460f-8f46-3c63a7d3b39a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc1bb3ce-a107-4f3f-8fda-e987eda36246", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a85baea-b8e5-4f3e-ae67-73d5aa1119be", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485a3916-fd6a-4753-a782-b21877f2055f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c24725-4a04-414b-ac90-e2843165a6ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ff502f3-0ec3-40bd-8b33-38e04ee7e2d2", "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\": 5119,\n \"message\": \"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": "636d22cb-b960-4495-a455-0ba7321f1516", "name": "Sales", "description": { "content": "Sales endpoints.", "type": "text/plain" }, "item": [ { "id": "43a436dc-51a4-4712-a65f-6e35f8a7ee9b", "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": "849d71c7-4d65-443d-8029-f0f633e80317", "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": "b6c65252-2eaf-44b1-84c9-d3d4e5039635", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52bd102d-2d62-48e6-97ef-55cea1b3e0ab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d56fa7b0-1151-416c-b5e8-6579d3b156a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d9e4ffd-f078-4750-a232-db3b4ab165f8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c511ae7-7fd7-4ac0-b40f-0342cf2bfcc3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08228a2b-7dab-4500-b89a-e1f1e781ca8e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cf088f-7d63-484e-acda-6874da66ef3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e112de56-f5f1-4916-a071-d55f632d7267", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e62aef4-eef9-467c-9509-31572bc84e82", "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": "51290e49-f63a-47f0-b87b-3444b69ffe3f", "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": "873e7ce1-cd67-4c49-a292-f1fac2b1dba8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a5ea9a8-caa2-4c26-b57c-ba66167831ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ab2b490-b41b-42ac-9019-103ca69addd7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c3501e-f61c-4845-860b-c89729a4e4c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6336eac-cb74-4207-a793-3c15619e1be0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c7e805-5395-4b8a-b69e-46ae0b137295", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80ef4785-33c2-4839-ad36-21f68a9156f0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a055d000-7979-4214-9930-3ba6e1bda3e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a4e55e3-34cd-40fe-b0c5-8dc2ecf6a50e", "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": "5b977f13-454c-47e8-8af1-18ae3e1b48c7", "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": "6b499a42-ff77-48b4-b469-388ee09e9d29", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d8e445-5bec-4400-8121-66a555e3cf85", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90cf99c5-3af2-40ba-bd0f-a137d065f3d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6c4a141-254f-40b9-8539-4e5b5d84c180", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "267ee40d-fcc5-4266-b145-6e568b981250", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8420f648-b6c3-4b03-bb0c-6e37b659b5e1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0242af4-dd0d-480a-85f6-b1dc6c2eeb4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb33b9d1-d304-4a8e-ac9d-125e82badead", "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\": 5119,\n \"message\": \"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": "26e8b838-6d48-4747-ae2c-e597cf01d7b0", "name": "Settings", "description": { "content": "Settings endpoints.", "type": "text/plain" }, "item": [ { "id": "18c75d0e-c243-401a-8868-7b5cda79dce7", "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": "a9f62276-c015-431b-9ba1-7ed2b3466a09", "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": "e068bd89-d8a8-41e9-8119-a5addf0d4c6c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "348ec426-9874-459d-97d6-4b4fa0f49bb0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f56a4568-62d9-4fee-871d-0242ce715333", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "089035b8-350a-405c-b9ab-956a9d5e5eb4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0343a1f4-05f7-4ea5-bb40-a57d6ddfe6e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e4c84ee-7b99-45f0-9d4f-06caec6fcc55", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7628498f-14e3-4730-93f0-05f48f6f19bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2dc1e79-1913-49c7-b0cb-86fede08c76e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ca6bca8-141d-4ae4-a2c7-2e986360e065", "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": "26b04eb0-a642-4452-93ea-a5803526b851", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:isEnabled" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"isEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1ea0746-b02a-4967-8158-4a5657b55a41", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f5b187-f2e3-472b-a005-8019e9087d92", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcdab6e9-0a63-421e-a5d0-ef4ba80f658f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec4843ca-e4ee-4cf6-880c-55eb732cd2db", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5281a676-290c-4362-b61c-b4e61a71e519", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e768e76-15ac-42fe-ab10-4f42e75f6c55", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23a4804-bba3-47b3-8550-a39ace2bcee3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28fdf451-8d52-478a-84cd-f32033cffe1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ab093c6-805d-4002-baa9-ef519eb83acd", "name": "Get Application Configuration", "request": { "name": "Get Application Configuration", "description": { "content": "Get configuration values for the application instance.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "TASK", "description": "By default, only application data is returned. In addition to that, data is returned for the fields that are mentioned in the query." }, { "disabled": false, "key": "fields", "value": "ECOMMERCE", "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": "64ac0a0d-8baa-4f62-8e7b-4e0fc20719de", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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": "40f462a4-02fc-4a8b-8e9a-33a2c8c71f99", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda529da-4a84-40c6-aa7d-17b468618b56", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea6d4bd4-24f5-4cb4-b41d-d95a4d34aea0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d3e86e-fe77-45c9-b184-610755960270", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3ef57de-0b5c-4530-bd3e-87d26cbde294", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c3fd920-5359-4b1a-a518-49b2a39b9e0a", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e2b5fe-708e-4def-a4c5-320004335ff5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a429728-3cec-456b-97c1-7a565e1e50ae", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "settings", "applications:getConfiguration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "NOTE" }, { "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\": 5119,\n \"message\": \"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": "29f4b793-7c1f-4ba6-8881-f3451864ac09", "name": "Shipping", "description": { "content": "Shipping endpoints.", "type": "text/plain" }, "item": [ { "id": "0bb224b8-9a96-4c7c-b701-7a82f3cb78a6", "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": "c0f2ca4f-dffa-4df8-a804-a4dece379d7a", "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": "10d4c89c-d221-4546-a7b2-f62c6b824b23", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeacd02d-faaa-4d20-a75c-59f78b4184af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4ae040-fff2-4348-8838-9330da47d98c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83bf7a3-3f80-449b-baf0-ed6fa2d2439e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3a6d17b-aa0a-4d4e-ad10-a923366c1e2d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da98b15-c47d-4e85-927e-fca2dfdff489", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae011f7d-318d-4368-90ca-5f2e844c4542", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf5b0d0-f49b-4f3b-9ad6-33847a694a9f", "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\": 5119,\n \"message\": \"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": "ec5cf351-65e4-49bd-9aac-72add6752a86", "name": "Shipping Discounts", "description": { "content": "Shipping Discounts endpoints.", "type": "text/plain" }, "item": [ { "id": "2a178834-6158-45b0-bd1f-e5f007506b35", "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": "dbf5238a-5fa0-44e7-bb7e-2a378df73fd1", "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": "8a2947c0-b179-4651-8c78-492694ef0ed7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e3d3487-ed43-4646-9323-dc22272aa774", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ca003ef-0702-445a-a7c6-94f19c88b555", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34279e16-2499-4dbb-a205-562ce41cafae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e3aa419-a109-4ef8-898d-b5ce44d65264", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c82edd-e832-4e85-aca7-6f861ca7033e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641b7bb9-cc8e-408c-a8c6-3c39b03a6cc9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d8188eb-acf4-40da-918c-289c9ddec6f1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34ccf478-a0c6-4a41-845f-171a40e504e4", "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": "b64f0ca5-66a4-4458-9027-67bfce8ef994", "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": "70009511-4b50-4e31-af9b-084251b6286a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7800dfc-3908-4ab2-a7e4-a71c56859cec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4555ee6-d47a-4130-a780-c007276b1a4b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb1f826c-7ac0-404d-be92-d64d82b4f51a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c6b149-6530-44ad-9b0c-680bd555ab39", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dcd2569-a795-41d4-81ad-83604823d185", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1274944c-2834-41a1-adb7-916cbf941797", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b81f7810-5557-4dc9-8d53-201dc7a99f49", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5d7d62c-1d11-4f63-92db-10cf9d9f015f", "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": "2d0bb309-8127-4e30-ae2c-51688b8d3ea9", "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": "8062eed0-51b3-47ef-b647-c6e15ce63651", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a629e35e-e6f0-4851-ac21-b46beeeb360f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21bf4a99-a89f-4274-a14c-e4b04561d727", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0265231-ff55-4a27-8151-44bd6b2e1deb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "988a8340-aacd-4cfb-9559-95492fc5e68f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf1b01c8-a88e-4667-bd9a-65ec591373b6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb51105-fc81-40e1-9842-a5957e1c7b0c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd7ad38b-edd8-4129-8fc2-0ac4c30febaa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cfd9f65-4200-42d7-9463-ae2517d6bfa3", "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": "94b37d7c-8fcf-4592-a4b0-5f4b55f85831", "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": "9674bb53-8f4a-4549-96e8-49b4f8175a38", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c380306f-3617-4bb2-b3b9-eb12c65df4af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8880472a-8b2c-40c0-b8c6-81eb57a97a19", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b264b82f-1a45-42e4-999b-28c038c09dae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c42aa4-ca1d-4ccf-a94b-ee00d8377896", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bc96895-538d-4154-a8f6-8bb5d64ad228", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d612563f-84c6-456b-afe3-cb9892cf88c7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f4a205-18a1-472e-b723-f9e6e661e891", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f43d283-7d4a-4386-b651-1d7df11e2eb4", "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": "1b79fda1-0d20-4e47-a331-49750e51e620", "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": "60c52fc5-5db5-4085-b71c-9ddf656545f6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4b50644-af7e-461e-8fb7-097c1eb05007", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e7c1b09-4003-44a3-a494-c411f91be157", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa833ab4-3cc5-4a09-a439-84769e245872", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45d7ee17-219a-4206-9c87-f62f37c127cf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e1db5a3-8fa0-423e-82c2-e26f86b1d4de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e08abbb8-7381-477b-b270-56fc506733c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9dbc4d-00bf-4e44-9bd2-0983c72648d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97fda0ef-62d5-4c56-bb3f-d60d81943286", "name": "Update a Shipping Discount", "request": { "name": "Update a Shipping Discount", "description": { "content": "Updates a Shipping Discount", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "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." } ], "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": "7633e577-cb69-4d49-a809-ce474699c758", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":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\": \"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": "094f9b42-5793-40c4-97c7-b2c3de81c5c9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bab48ad9-257e-4d70-bc80-6f83a45b3c09", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5c5766-a89e-4e82-b74e-ab2d08ab4c80", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72ddff3a-f9ed-4d82-8c7b-2cef88ae369b", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b18265-2adf-4b28-9d18-ca2c2e846031", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507a0e90-6e7b-4b35-87b8-8998ff33b2cc", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "143bbcaf-7f93-478e-bcab-33caeaaa9554", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2503d631-0413-4eaa-8aed-4fbbfb3886f0", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "discounts", "shipping", ":discount_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "discount_value" }, { "key": "update_mask", "value": "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\": \"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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7295f5b5-f07e-447a-ae2d-4ec8751d2b58", "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": "bb01e827-ce11-4f13-a578-c6b621e20efc", "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": "60dd767f-f701-44c2-8980-dc31af990c68", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16665dbe-08d0-4588-bf80-36d65d572081", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd824b7a-6d9d-4389-b57d-84e3d14c3f3b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31fe0921-defe-4a61-8ff0-5aeccdb3f2c9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69cfaea5-c7a6-44c2-a75c-437eb5e06234", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44911d50-0d0d-4f33-9a84-8300bbd3fd44", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2427fd9a-92a4-48ab-8e2b-88ad92294375", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d3a256c-5ae1-4ba8-ac8b-5d14169484e6", "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\": 5119,\n \"message\": \"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": "d3e2c625-97a7-4475-8fdc-e9f0d1fe89f9", "name": "Subscription Plans", "description": { "content": "Subscription Plans endpoints.", "type": "text/plain" }, "item": [ { "id": "0821a08f-39b4-481c-8558-92c9170123b0", "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": "d1f754c2-d305-400b-bdda-2e9946fcd602", "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": "154799b2-abd8-40c7-a899-72b9f2728afd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4c9e9d8-397b-48d0-b921-58f13dd87cef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a28155b3-db52-4556-95e8-0141d36a8c54", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03d9234f-cab4-4d01-bc87-1f7510c316d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69921428-1b63-489e-a22e-7b9b5832ae5e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37646552-2081-469f-b5fb-4f736f4cf4e9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72bb4b7-18c2-4a92-a140-36143e3279b9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f8a7aa-cd1f-40dd-b87c-554afba50187", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbe8f3a0-8806-4a8e-ada9-264036b388ef", "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": "51829882-0cd8-4275-b15b-6a7391b42658", "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": "60f5d82e-0e73-4f3e-917a-2b512641730d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da50571-d983-489a-8365-f09bf5964288", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2571fff6-50e4-40a0-aa23-67dcb5449e1b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9488e33-1f6b-4a87-b7c1-92df7e4aedb7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2515035-0311-46c0-98f7-1c1b688ea3e3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3b4926-eeb0-464f-97e3-88f36c86e42c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3146ffce-a8a7-4848-86f1-73d8d099f3ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "831bd93c-f39c-4e93-a1dc-0e7bd6fc5e8c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbe5e3e1-656f-43c6-a122-54e951a1275c", "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": "b53a7059-92e7-4fc0-a53e-e209d3ca687c", "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": "9e668c78-a2e1-4e91-b936-b29886b374d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f56330b-eabe-429d-b1e8-1f39e36032af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2a2ea66-33fc-4433-863d-4d509b844048", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96b2cfe0-4619-4cad-a7b6-91db4291ce62", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa94ce8a-6669-40a1-968d-f2237aa54b82", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4fdf56b-1b44-4162-a6f2-2204c78bb60d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b89f3aaf-2d46-4c6f-a575-9a6ed1f6b53d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b75a106e-c209-44a2-abd2-e98c86ba9ea6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88fd38e5-656c-4a17-9ad3-ca31b8ac4ac3", "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": "253d15ea-3b1d-4882-b7b0-f828168788a1", "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": "dd85db43-2290-4ca0-8f55-9066eec31706", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e02e39a8-fe1b-4f25-b8b4-4039b838a4b8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "996ccd2f-0f92-427b-8ef0-798e08739595", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3483341-42d6-44c8-9574-0661728d281c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "755d8273-2e36-4a14-b292-29bb58807040", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29eac5a0-06c8-44a1-bca2-91ddb840cf3a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af978eb-08b6-4e72-9dc8-df9dfb94d901", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47fe9ce-2b96-40b2-abfc-ad62e044e739", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f61650b0-2f3a-4d39-abd1-17f5122c6e6c", "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": "cycle_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": "active", "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": "5833d3f8-9485-40fc-ad46-05950b3483c6", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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": "62f23596-5a40-4616-9c2a-dbc555eef456", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67234023-4431-4ec4-899f-fa1b47e49338", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a46596f-98d3-411f-85c9-d247c00b2625", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43163ed9-72bf-4772-9b51-af90b879b700", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed34c071-02b6-4242-89a7-ba7fb7a5ea57", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5f52904-4082-49f0-b4a4-a1c5684edb02", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52675de7-41f6-47bb-86a4-af3e81ba93e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30cce27f-7f6e-4939-89a8-95c4fc26b2c3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "products", ":product_id", "subscriptions", ":subscription_plan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "frequency" }, { "key": "update_mask", "value": "display_order_index" } ], "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\": 5119,\n \"message\": \"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": "af82e497-c508-47fc-930e-94e0cd9d869f", "name": "Subscriptions", "description": { "content": "Subscriptions endpoints.", "type": "text/plain" }, "item": [ { "id": "f994ec86-e2ac-428b-b512-990baf56d362", "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": "536f42c0-85fb-4a6a-b701-918deb4c60c8", "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": "0966ab66-39a4-429a-a745-4feb03b5cf3e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ac1c87-9fa6-40a6-8ab3-4c1796b2cb70", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b3734ab-191b-4074-be70-b95f638a7525", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa4a538d-3271-4cd6-b780-ff6d6584e3b3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "459b0fae-2ffb-4a31-bc9c-86543412c97b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956fc570-0b7d-427f-b14e-0c68072ebf81", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24c51fb-64ae-44b5-897b-1a8e826ee099", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00138f33-8bed-4b67-a993-15a42631f34c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12ca3ac3-40b1-4ed6-9434-45ec419b6a49", "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": "4042b573-2e74-4fd5-a11b-c145912cb4fe", "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": "e8935e73-d55b-4cea-b948-eece3cb6fbea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484b94bf-1412-4acd-8bfd-9b8a99c40415", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be03092c-3130-4273-ba3b-b1ed5e1d2947", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b810c830-042a-4ac7-9eb9-3c4844a9bf4c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b4a951-2cb5-4a26-9ba7-3ea567ebe53c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f113f66c-b24f-4431-9baa-3759dbdb974d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f74457e8-0a14-4ece-9157-f610dbc38cf4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0630d8ab-ae72-4aa6-bd37-f4256cdef909", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c871775e-1456-44f6-959f-f347a2c796bc", "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": "fbb7dcaa-3e96-463c-9c48-da03bb543932", "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": "7f48e656-63e0-47b5-a8cb-e2dbcd249266", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a57555e-0c16-4126-87d4-ce40e81df238", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f651e6-ddd9-4133-958a-c4fe77a9ddc2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1e986d7-4535-45b8-ac6d-f8c47aa95427", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b4bdef-ad50-4d06-bca8-8efe30fc38a8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb6de72-dee1-4f19-bac6-b9455f522fca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92266b31-30f2-496f-aa63-b27809cda2c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f72212a-35e5-4d45-a653-eebafab1f360", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3e8a58e-bdf4-472f-a4ba-7f25cb3c095f", "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": "7bb83f61-4348-4dde-969c-302512a9e88b", "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": "4c8b56b5-424b-4747-8ac6-92a2c0747287", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fd67ead-351b-484a-9b43-bb6ca2ae8c78", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de06a25-f230-4d6d-bf63-7e43e9dc455d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3f8c3dd-6162-4f1b-a143-83e45ddf414e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68cb50a8-11ae-406f-a0c3-fa98c43044ab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c2490f-ef94-4f13-bb77-9fd77032f1bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3d0110-aaf2-4e7f-89f9-0bdd5392598e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138e84d4-b8ef-4603-b35b-d82a268e45f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24f04036-d860-44ab-9b0c-31f771f462cb", "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\": \"PERCENT\",\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": "7d5d90be-4507-41eb-b811-19427d16b546", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ef16feb-3be6-4970-bb90-16ecd30c850a", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e492e1-b352-4901-b90e-6a16bf2be38b", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf3b975b-aaab-4925-9566-d2850dd35f87", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df98ba8-ea87-454e-848d-42aa8990df11", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a28a1b-0b59-4c15-a848-66da84a1da85", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d628715e-2f22-40dc-9d3f-7878d10a6067", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "432b440a-9827-4ee3-ad5d-e5ca8ca46427", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac26d484-055d-4745-95bf-cf3d3b10deea", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9001e377-e002-4182-8cd2-01069ace54e9", "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": "0a7fdc7f-e3a5-4972-ac8f-b09a04f1c02d", "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": "97d8f00f-195d-4641-85eb-da38a02044c7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9cb2f6-2dbe-4c7c-8aca-9d83399bf5da", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bafaa08-8897-4b56-8c24-fe00bd9fa808", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d85d391-8c9c-4885-bc7e-a93f75b46513", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26d86590-193b-467b-995e-ca77c81d06f4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ef8ca9-b4c1-4af1-81da-749a4a197bb8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9383e37-c6af-41a1-900d-91ac30060b69", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc632c94-7bf4-4aa4-a676-2933d5912a1f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3a01c61-5789-414c-aaf3-45b93c129b33", "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": "80ca0195-d0df-4392-b452-d3ce7a4fb2a3", "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": "832c25d5-b105-4c4a-b0e4-cc1f882daefd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4b3dd6b-ebf8-4cb9-b2d5-15f3d81204bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16719921-4ee7-4d7d-a38f-48593a03f92a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c224c3-cb4a-438b-82d9-e4b59fbd1560", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b1df3b7-b606-4afd-ba66-2b6e853668d1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "885d3f88-75a7-4ba4-8477-c0aef103c938", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "788a4673-c250-46d2-9d63-28653fe2f76b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d07f3985-de7c-4bf1-b5a2-0cf8f095204d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "141e6867-777f-4795-95e4-729694dc7e0d", "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": "5502554f-f8cf-4401-8ed5-67e19f45e816", "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": "db7021c5-ed63-4432-8439-00d6f92e669c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc3d1e40-4e8b-41ac-a8bd-c717a541e3ff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9d9f2e0-053b-4899-ac78-cedd0bd39778", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c72879ac-9c89-4285-8637-f7273f326c62", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2449ab91-7036-457a-bca5-a603a119ec77", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74896e0a-b9c3-41e0-b43a-999690eb46ec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ea2f7e2-6fa2-4ab1-bd58-2417d852edf4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a9f2780-43b1-4826-85d8-30981859c363", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e8710da-7256-405d-8f83-616c84345b72", "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": "3e12f1ab-2f95-42f9-8d8a-609b69e12a85", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9821c374-d831-4947-a34a-21f9093a2815", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36e06f3d-6fa4-4711-b43d-0f54fef2b212", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d40326e-25c0-4fb1-9dfc-74a76dd9467c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e88cef-b576-43a2-a6e9-bf4f869a1505", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d7993a8-e081-4453-a5fc-866141dba3c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954213ea-a1be-4932-b888-077cf6c0ee30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7ef1e58-6e0c-44f1-8f58-2d8bf12e5e22", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "449c6b9a-90a2-407d-9f08-d7ca5f1c7bdc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fbd4cc0-417a-4945-8690-ba97409d18d8", "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": "979fa5b6-4950-4557-abfb-aae94de64dca", "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": "bc59753f-973b-412b-8ea9-5286bf92cfa9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a6b56ae-f70b-43a1-bcb1-d96677f4791b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20934fa9-d367-488e-affc-e9670a33d217", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d81154b0-ef88-4dda-9a6c-c318b6a0d17d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2584639-7ad3-48fd-8dea-aead12b98d20", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7389185f-c13a-4fc0-b5cb-31f53f7921fd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e90c28ac-e59d-4faa-bee1-cf4a9c559095", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a865455-e95e-4209-b46a-0d1b01aad52d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a8b199e-4311-4788-a95a-754f947e593f", "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": "shipping_option_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": "custom_fields", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "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": "fcc90879-8fc4-4278-bd15-2422a72ce379", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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": "ab982b48-52e6-420b-969f-94b3909ebc0f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8f8096e-ebcb-41fe-9163-83bffe7a240d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f3d62c9-f8a0-4311-b6fd-4ad4fb6c2e6d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6c37b50-e608-4679-bfe8-721a8fb5df9c", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d13004-42fa-4bbe-83ec-cf9b895f82d0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd38e267-10f2-40fb-8f32-ba9a17075132", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57519149-09cb-48cf-a5cb-83f9d4d934f1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da0b09e-d5a1-4940-a1fe-0eedd2a399fe", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "contact_id" }, { "key": "update_mask", "value": "allow_tax" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d04bb05f-a869-4ecc-aa14-51a5d3da6223", "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": "532ff62d-15c0-47c6-be62-b86aefec3bf0", "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": "698c3733-2b58-4a62-945b-915415d0e4e8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7bc5156-2efb-4c75-be01-7823a3062f1e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b07c0ac1-87ab-4a10-aeae-a7b67afc8d7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "600bfd03-e8dc-49f4-906b-907d12cc6d11", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bcb121a-da5e-41b7-8bfb-244de662c8bc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "879e232b-c952-4d7e-829c-83580aae2674", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dd46162-9e95-4785-b770-b0bd6e4bfea4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efbc0f5-eca8-4fc1-8675-7eb9d5ffb512", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "069967be-082c-4072-992e-91fbdaa400f1", "name": "Update a Subscription Custom Field", "request": { "name": "Update a Subscription Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Subscription object", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b60822f8-274a-4de2-94c0-813ccad68065", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efe4df9-e8fc-456a-8255-b9662b72e2eb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b04436ac-f8bf-4d3e-8ac3-b08c001b93de", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2be05c9-40a1-4cb9-884d-ff673d61c944", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ae8ef5-a0ed-4957-9307-81314e373c1e", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffbf7c8e-5523-4dbf-b4fb-3dddb4187e09", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa493aa8-88cf-4548-ac59-72dcbd319955", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf07fbd-0470-4cd4-aa5c-4a14b137d3c1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef0cfb51-d285-45e4-8fae-886633a95ada", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ae8b102-41fe-4ec8-b65c-e0ec1dbb11d2", "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": "c41f2d23-0803-4eba-8fe4-72f0322f32c6", "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": "250a174c-95fe-48cb-b1ee-2d860f311003", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6163ebf1-612a-47e1-9e4d-f4117ff19b67", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af097f3-c64b-4284-814d-561d6bee0fec", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3736163e-6409-4e93-82e2-32b6c0d1c3ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c2a61b-9fe7-47a4-8e0a-d6847ddfc2cd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08af3c00-75a5-46c6-892d-5bf30ab89dbb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ee685d-a744-4e6b-a31d-1bd1d92d2dc9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f5bd3f4-756d-4e89-bed4-624eea4bdd17", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f889cc8-4f52-4783-a5ef-99b5126d36d2", "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": "003dafe1-3584-42a2-a5eb-9dd4db9ccced", "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": "e10b3357-16bf-4c36-a91e-471165e10552", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40bdc25d-dacc-45da-ab05-5f5af2c96f71", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2353d175-0599-4403-986e-268939315102", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36749c4f-d1e9-45b4-bc20-aa8e654b95f7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fbfe1c3-0374-4148-848c-589ca7439bb5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd6251a-2aa4-4ec5-8963-a6c661914e6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e045eb0-755e-47e8-80b1-be0f62946f62", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb3df1c-172a-4ac0-b800-4f7be0146bdd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1427b105-8ffb-465f-bb53-edeadd35677b", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c75a5bb-6e4c-466e-b6fe-ddfaa7797825", "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\": 2647\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": "e91b311c-0c79-4627-9668-5177e488a07d", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13add25b-f8fe-49a9-8ea4-80caa23443b3", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fcff10-5ad3-496e-9895-0cdb42b4ca77", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b6ee18a-c4ae-45ba-a11f-f9c12f641622", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e231011-8115-481c-a832-69de9d3ad17e", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7320b9-cfe6-4e80-acf7-920cae0c763f", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4aec664-48c9-4b75-840f-6d821400c0c6", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bba837c-b5aa-4a2a-8f07-2bf61db165fa", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e20707d7-6699-4134-8216-04c706f0b3ab", "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": "4d5584b6-51b8-4d3d-96d6-7f961bd7f8fb", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "718384e9-eaf8-4099-afde-f8ebda190aca", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f16ca4a-391b-4341-ae29-c4c2abe90f99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0086352-795e-407b-a309-224613d0d369", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d1256d6-3482-4d7e-9a4c-fd96770ec033", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c2a7691-b2b7-4efd-8411-7c9b562ff1f7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52bec1d6-33d0-46c2-9ec6-3dbdebafaa60", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e686129-0346-40d7-bed8-e9325d09cd30", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5848cb-442c-44ab-99bd-8b2f702b51bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71084c0f-7743-4437-94bd-cb4924652cba", "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": "a67a0add-2128-472f-899c-6ce6e23909df", "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": "c47d1b7d-b28a-4efc-8ebf-ae181acfb5bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a43fab4-1490-40a0-b526-36f5ba31f1c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2a4be41-dd14-49f6-8ecc-ecd26c80a2ae", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffc55175-8d18-4f6b-b9ca-c41ea74879aa", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aad3a19-0d58-4dff-9524-ce5c723a6bb9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b07a925-7ccc-4b9d-8e21-930fc8c6302f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0069db6f-f504-4614-8e7e-9223b1c1d72d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6c398f6-e404-43cd-b925-d3268cf87835", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4fa0604-7460-4534-add8-560ef477afb1", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1a7cc3c8-cddb-4b06-9be2-90eb449a300f", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956990cd-2f83-4c7a-9484-441e49586c40", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8068e642-ee08-4acc-8bfe-7306f1c74e19", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b353baae-a960-460f-bb46-e280bdcaf2ae", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ccc14e9-d7c9-4a09-af8b-4ff37c30ab84", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45d65e9e-84c9-42a3-aa8d-c0d3d59ccaae", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf2e18a5-746d-4956-a369-4ad6b7b0cccf", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b277887-6c5d-4a88-898a-5bbeecc1dfaa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b056ea82-a4a9-4e87-8e0d-c2a25704ba87", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "subscriptions", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6dee098-f6f8-420a-9efd-63a63ea4b845", "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": "38656b45-7fb8-4bf0-8c44-3c55141b7e35", "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": "e5d6d770-62ce-45e8-b29d-ba94b34356d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814b64e8-4068-4287-a13a-e0dad5431dd0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75009d89-4754-4bc2-a5f4-c33ea7d81724", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cf555d8-de11-40db-acd7-bcccb4e35bb9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd516da-1316-463a-8448-93a8ba9deb05", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5066e523-ae68-4453-8c64-75e524770d59", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "347852b6-e25d-47ab-8fe1-7d88de6cdea1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c53e540-f26e-42e4-aeb2-88d9e35b5c98", "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\": 5119,\n \"message\": \"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": "d2bc3d08-612b-4a35-97d3-d35b3eea5b92", "name": "Tags", "description": { "content": "Tags endpoints.", "type": "text/plain" }, "item": [ { "id": "3ab2db9b-da3a-49ec-8a9e-2b37bbc6e01f", "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": "dedffcf0-54e3-4a73-b694-f9acdbff032c", "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": "67c26b6d-229c-4bbc-9e56-0856885a515c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6a44ba-0238-471c-8d93-667df33573de", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001406df-638c-40dd-9e8b-072f61603434", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eeb372c-6ad3-4d41-8af9-21c3aa00caf2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f13fb6cb-1b4f-491f-a6b2-863925390c4c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5c1c998-dfa2-4a02-bd15-169c08aca23c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06e63a03-ab4a-4d4a-8343-90d56e0f9767", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "379d18cd-bc5b-4c35-a6c3-28499dfe4c09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76a33175-658c-4615-b4aa-3d64cff7298b", "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": "4fe0bafc-335f-42d0-bfa9-b53f46d68d62", "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": "ad54b662-45c0-4a76-a94f-8bfcaddf69fd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c37a1e2-6cfe-4ebf-9658-4f5e6a34394c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd742c00-c690-4ed8-89d4-7768f1b3881e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7495c7f9-7825-4edc-a08e-1473d5110c2a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8288f4b-86a6-4709-8b85-871fcada7b44", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42ab1d10-9594-49b1-ad7d-7c43bf362683", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a5f12e-a725-4ad8-bf21-c327c44a38a5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb96570-706a-4f33-84b5-2f4f6003a8af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58b98d34-2256-4280-9da8-c4d22eed2a63", "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": "6cf30b8d-3b62-4d65-9a07-c2d63a96111b", "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": "a64e6708-8b3a-40bd-9b71-585df6db819c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de5b2b3-972c-4b64-a696-7bb078a0de93", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad722a85-52ea-4fa2-9992-3f3a9577f85d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6283dca-efd9-43f7-bd56-b50edb23307c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aa79f07-ae24-49f7-b8d3-f71a18f62615", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1367557b-8347-49ce-bc72-2c76bb6cd299", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1788e235-0036-4fc8-851b-007fc60a3565", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9ef8fb-8a32-4296-bce8-0298199e4aa0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb405ff0-4ad4-4e1f-b743-0fc76d7aa40b", "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": "adcc6f62-272d-4e18-bd38-cdc9f1f5efb9", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id", "contacts:applyTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"123\",\n \"456\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41757092-12b7-4bb6-8709-4589f6ac07b2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f559d352-3d29-4613-bd3e-b931325b6e78", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e8c3540-c949-499e-b9d8-2516e0d44f6b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7f5e168-1ebe-44ee-80af-832b527118dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f919392b-ec94-43e2-b1ec-552576ca3754", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12b35d59-4980-4e08-b5b6-291b4c0cebef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e03b138-024b-4c77-bd91-06dce2b9ae84", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38a6fbb2-3c57-44b2-a448-31ea995c7cc8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c649548-a1f6-4483-91c9-764f37b5d0f7", "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": "7838ae88-cafe-4b08-97b8-4d3b98ca5a1f", "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": "0a9f7c2a-9f9b-42e8-b167-7f2b2dc1c62e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9145eaa0-0d8c-471c-ba3a-6a7f36431404", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a7f252-ef88-430b-96cf-2aaa20985e0f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "792ba8c4-ea4c-418e-831a-8a539f5d2547", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad98cc0d-a265-41d8-80ea-f6c75f6d2376", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f35f3fa0-bc99-463f-a74d-b72420eb9ef0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d178e0-0969-4caa-92f3-57f49bcfa3af", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54298460-4d41-4669-8661-40907514bf7f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a93dddea-0011-4431-9f3e-836c4e54f2a0", "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": "5ef20890-f9fb-4406-88d6-7df72e271cc8", "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": "41edc611-cb9e-4331-8797-328d162011c6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d486116a-9f51-41dc-a518-989ad557904a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9402df66-05dd-4884-9768-413a8eaf47dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bb62c3-a256-403f-b986-bf3fb7f74fb3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450c4684-7266-468e-902a-a8ef0b66ecda", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71427334-191f-4520-aaf7-2496b6a0fe53", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8aaf6f8-60f2-436d-8a00-89410a36f869", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdd34511-8c11-489a-8d37-6b15621200a1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0623e6f6-838b-4cc3-b86b-526fad8dd6d0", "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": "fda1babb-6a41-47d4-a33c-68a30261321e", "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": "520e70ba-db55-42ce-ba8a-c4f60fbc6dc6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c0d0d19-1bf6-4e3d-9d23-88c8f59d2151", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9aa3739-3a6b-4fbe-b6d4-829c637f1da8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4d0759-5179-4ed3-bd35-9a245ecbd5b4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4436f6ca-db38-4a9e-8393-8ada049333e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8075adb-54a2-4570-988d-293a9f5e396c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fa66ab-46a7-4b3c-a8a2-d014edbb386b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc393cc7-7894-4a6a-ad85-d2b8b20d7354", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08512f0d-e310-4e39-9e35-8f300732c021", "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": "396fbfd8-a065-47d8-aa1c-35029e95fe0c", "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": "e7b54465-3749-46a3-8125-ed25c3908240", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca13d1de-0c9b-4041-896b-551a3ae9185b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e1521b1-9c60-46ef-aa1f-ec69bbcb8ebd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7daef212-173f-4bfa-a0b4-ea341761d149", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "777e31ef-2d95-41a9-b32f-6384240d2670", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69b63371-995e-4ea9-bf0a-c39cb63ff24b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c0d023e-5ee4-46ee-b8a7-8e93c1c2e5d4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a63ee471-7e7f-4274-a696-595ad8151068", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3095a53f-9350-4c18-b242-734ae1062ca0", "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": "05f2b314-0a82-4766-a60f-6e8fc6882208", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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": "b9006220-ca1d-4bdf-b37e-84b6e9cd0263", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98ec325-171d-4a0f-9e40-db94461d0103", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb61d59-0676-4460-9260-ac2f987dc4da", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07202e07-4a33-4163-a5c9-7d6a517480d9", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c5c8d73-6285-4720-be91-49a348e7ebd8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "047aa2d4-c351-4804-af65-65c137e6c6ab", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e39b29af-a88d-468c-b0a3-d1077a427368", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08ac5de6-4923-4d26-bd55-0ba49090dece", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56c66520-6b0a-44bf-af17-0ae54a277f98", "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": "cec1b061-0480-4451-b733-536bd07fcadc", "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": "56aa9cf1-5798-4ef7-ab45-b6ca7dff4d21", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffc0d15e-a3b5-492c-b547-f664c4abf876", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "741eb812-053d-4f00-8017-37ede02b2546", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2490be83-0b9f-4a5a-969b-d00ee8d90e69", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fbbcead-17ab-472b-a53b-133a55f82b0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1623ac9c-235d-4a66-99f2-a9fac1822b55", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfd900a5-3622-4f92-854c-6af904cd256d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "929bfc14-1c58-437d-91ab-4b51f26be694", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d6089c8-ecd8-4dfc-9a60-00d455f64bb4", "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": "f3716f2e-0fe8-4748-bb4b-18a2f7fc072e", "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": "fd9e9f8c-686d-4d97-b627-824c8e5cb25b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4588c72-608d-4831-9124-10e803148908", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b7548d0-4ec2-4c8c-9a9b-acf513a233bf", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "089d1b68-9323-4e44-8d28-33523697401e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7006b1d1-86d8-44e8-8cac-5ba850dd84a3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6122ba8-a573-43db-81e5-fdde6abc0e8d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70464c9e-a141-4868-9ba7-537e8364f136", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6be2655-71b4-4282-b909-6b0dd0749854", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf770f76-d37c-4f10-b179-b42a67f1d540", "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": "18ae7b1f-8a1e-49d3-a706-c6908a341bc8", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\",\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"update_time\": \"2024-03-15T10:30:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cf1f425-04b2-4e79-8bf0-a6ab3f14c7d8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe9545f-7426-409c-b632-483a9d55644d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a560210b-e749-4666-a091-0e1a4e75c8d3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed0f41b-5ea5-4989-ae8f-677630a33be5", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3a7964-cf03-4e36-91d1-9e1286948989", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa66aa53-a037-4511-aec4-690cd96dae6d", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f62d7cc5-780f-4ca8-a3f7-aef448cb68b8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76b5109-9e9b-493f-ba66-717f52340e8f", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tags", "categories", ":tag_category_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "tag_category_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Customer Segments\",\n \"description\": \"Tags for customer segmentation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9172fe5e-cccf-40bb-9d99-38f643e7e484", "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": "2215ec94-ffa9-4481-a163-0830cd38b9e9", "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": "aac4a0d0-c548-462a-a787-8f0762ea6722", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d8d034b-e84e-4e31-8efc-28a864fe542a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24f5df3f-ce5b-4573-b682-736432da2ccd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4601c25-a15d-4ac2-8eb9-d6211257ac61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d03f5a96-87ac-4fb5-b725-33553dd5c913", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81c21db3-f7a0-4b59-a96b-59ad0a5f0d25", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a4656e4-8951-4d38-a79e-658c45fb6091", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53fd8eb-8e16-4955-a451-718b2b0d9476", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5308bc3c-e952-410e-b23c-a30ba33a1d64", "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": "c797e82d-aa3e-4a25-ab8c-61ee06d33712", "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": "6b677fd6-2b1d-4e56-866b-b7e1f65dc32a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9475b99f-f407-41b3-a269-c590e5187032", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caf33f38-c253-4982-97b8-dc9f5d90ef14", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6be61cf-902e-41c0-a80c-412e9c8cb04a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cf8357-0614-4f26-9493-563e265b6bcd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63347bf-1dbb-4148-8572-e7c753264d52", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb43f13-6746-4162-bcf4-068f60de1a91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a3003fa-1e60-4c07-ac40-2469753eaaa2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0481a0e6-fd95-4777-8be9-fa9af9571eb3", "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": "4e3d3026-bc87-4dca-b423-f00b829cb5ac", "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": "767bdde1-702a-4df0-9f32-3688d2346454", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d3fb585-5fb5-4abf-9492-60636aec6364", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e78337dd-f195-41cf-bcee-24a9ca690cd8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "369eb1d2-dcc2-414d-ac2f-ed714b66e675", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8df0b83-2eaf-4184-94b6-19740371ba61", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4810f4b6-6c26-480c-a0c4-38d943f7fa95", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00e957d-1fd4-4097-be5a-8c6ced9e146c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6814b90-44f0-43e9-992c-78d96f3ebba2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "335148c2-c0f1-4c30-b750-0a0e37f749f8", "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": "355a09c4-28c2-4379-9f14-f1a6a9945dfe", "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": "305a7a29-d0f0-4fb1-9cde-f97eac36b339", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24b2428-1e69-4205-845b-745478dce53c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de680ae7-9cb0-4fa8-ac23-6bbc0ed7ba78", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0363c1d-52ab-44e6-91c1-735304003910", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea2f112-17ac-4bdb-adab-205d450e5e9f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9714ea-a890-44fd-8896-0e6772a74c0e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1554d9fc-08c6-480d-ac1d-52256cea90c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd031f54-3395-4248-be20-44272ac867e4", "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\": 5119,\n \"message\": \"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": "b976d4f1-e53a-4d54-9bf4-aec9dd89e008", "name": "Task", "description": { "content": "Task endpoints.", "type": "text/plain" }, "item": [ { "id": "536d83b5-b705-4ccb-88af-22b8e5df44b1", "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": "fa5229d4-a6a2-4cd3-85d6-5b86eefa0ade", "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": "5e717fd4-4cb4-432b-8453-2c42453ae973", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c7507ef-fc0f-4dca-a860-4116670f000f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0376dcec-8ed8-45df-bc62-e2eb4701eaee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f3a18eb-a3b7-42ca-9fb2-d17d24bcaadc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82bf8d4b-b27a-434b-9509-c4709dabda09", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0255cb47-bdf9-4ae0-a531-e30af67db9c4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "056f9299-b92b-4bcc-9ba8-b346bf250a4a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d854650-0990-415a-9604-5ac5b9bdfb0d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b2482a9-a44f-443a-81b5-5db8883bb676", "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\": 1440,\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": "670b92be-6116-4bd0-9f91-65a540892c3d", "name": "Created", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review and respond to client feedback.\",\n \"type\": \"CALL\",\n \"priority\": \"CRITICAL\",\n \"completed\": false,\n \"create_time\": \"2024-01-10T08:00:00Z\",\n \"modification_time\": \"2024-03-15T10:30:00Z\",\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 1440,\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": "f16e26e7-986f-433f-bc6e-34e44c1f1a93", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "947d87c9-74c3-42ff-bdf4-c8a4ac25b57e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03f34632-1d6e-4461-a62e-1c14b46d95b1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d1b0d7-ee3d-40bc-99dd-54877d192f98", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd6b90bc-5969-4368-84a9-6a15fc980047", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f438babd-d09d-4520-bbd1-3e179be4a11f", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6a24ca-ea8e-415b-9db5-f2b451135ed1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3aba694-f8b7-4a1e-8aca-6cd1b033abfc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "custom_fields" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assigned_to_user_id\": \"string\",\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a54a9292-8653-4bec-8091-b9fffea3bd0a", "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\": \"PERCENT\",\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": "8c858a57-0778-4d4c-b0ef-418c5799fbdc", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "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": "3b64a350-0616-4ea6-9ca0-bf79821bc155", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ebe8d6e-321f-46ce-b6bf-426a8b55e52e", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4770e7ea-03a2-47c6-83f0-3bf44c8df869", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b47f01c-c81f-404b-9fe6-e85b9a22bd89", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1240145f-ff57-4587-9a6d-7361aaaeb56b", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a283b8c-3d36-4e24-ae83-fc179d5648dc", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e9406b-3314-4c1b-a191-99f396ed7246", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0db6c658-4da9-4eb4-becd-6b2f3f7f7618", "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\": \"SOCIAL_SECURITY_NUMBER\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"group_id\": \"string\",\n \"user_group_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff157efd-a873-46f1-a541-7ab4dd976db5", "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": "2f93c5db-97ad-483b-b3e6-a033fd6ea5f9", "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": "7f0af90c-d9bb-4803-a0ef-8dcbc504ee48", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2123c5eb-5808-4e2f-b6bc-6a9608aa2f9b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3940271-59bf-4848-8677-73ecd3b57f2a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34c0ab7-a35a-41ce-9978-d8644e0b40b4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05beb1ae-0269-4758-aab6-71e6c488590e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffaf31f7-5e7b-4564-a516-038e8849e361", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef426181-ae8f-4e15-aef3-0425532d5774", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fbea546-5f33-4a90-8ee2-ffc7ced6ab41", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "010ca724-f052-4fa3-928e-b5f7d59f5d58", "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": "a2bf63b2-7408-4f95-ba59-846f111e97e5", "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": "221bd800-5906-4b52-8a82-47a302c41222", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18751177-063f-4bcd-941e-8e97cbd450c2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b94c1f-2feb-4427-a954-c3ea5be1eca7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "420b62ae-a999-40ba-aba0-140c6408c836", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf4e044b-b482-4fa0-b66c-ca3f7dd9408b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "140f5c4e-5cc9-45fe-8a45-60bea81239e2", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8a530f-cdee-4ebf-911e-e8dce4629509", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51ae32b6-d191-45c3-ac00-3a24cd58bfc3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45c03ce8-7892-4f9f-bc80-c896bdc140ca", "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": "ba02332b-f8ab-4d5e-b86f-e5a8e9ed552f", "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": "0f461854-9958-4e66-9f9a-40d12cfc02a0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "913861cb-3619-4490-b369-24889f042d50", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776fb846-9387-4470-8b90-d991d4285cdd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b57f5c2-1dde-4522-8c12-084807ea4728", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc34a2fc-04fc-43a7-87e9-51a3ac3986c5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a26489-2bea-48dd-9f56-c1a43f7dea04", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c13a4b0-d806-4c53-a8da-fc9275c1cbd5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94333cce-3535-4352-be7f-d92a9830c99a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "541f4635-460a-4063-b825-5dd6ec1acb61", "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": "e4d5908a-eef0-4bc6-8509-ab6449737e78", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c665fbb-bb17-49c4-a0e9-98e17b48a149", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9194fc5a-1e61-4ad8-a8e2-a14c934ce065", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "754c443c-a1bd-4260-8d07-5d006c396532", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9e0a746-f97b-43b4-8f0e-bde928cc94bd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f90ca37a-9353-4d9d-98de-09652c40b7e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a1aacf-9ae7-4534-ba1d-d00cce4f15e5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87809a23-cce7-4019-9b06-b7e6554ff81a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be87b920-1f64-4ad7-ad21-b35c429be1e7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "888463f6-3908-4616-8e96-3b8ad52111b2", "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": "f645ffcd-fa0b-4703-950a-a414ef4e25d3", "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\": 1440,\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": "0472ea28-b5b5-4169-9958-e09035a79704", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a2ad50a-30d5-46d7-bd8f-dc8ee85bd875", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bee03f2-90d6-4f15-bc5c-05dd4147409e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "138db360-e4f3-4f0a-8c2d-647ed96578c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87dc3597-97f9-479e-be42-9b1234fbd77b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9edf808-c21c-4884-862b-b61b495e02b9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e7a995-f0da-47b8-8f67-ac2b0049a051", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41d55a6f-75a2-4f31-add7-fa55be9a1210", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be3f7570-8105-42c4-854e-4b6b8de45592", "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": "ff453f92-6912-401d-97d3-ecc402a0575e", "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": "53ab87ac-7c29-46cb-9809-3932fc3dc479", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfd151d9-3ca2-402c-99c9-de63e0136a91", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f4f2d6-5d48-465c-b0fb-1f669b1a1366", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e230bc-4a70-46e6-8670-bf92d51e1923", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0af8620-4b05-41ef-b2ae-8d03a225da52", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02126c38-1460-44b3-ba1c-b31e03ed6056", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04ed1d9b-4674-4685-8d80-e0f0707c7e3d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572e35a1-e120-49b7-a483-98cbb453e3d3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "918169b8-21f7-46da-ab02-a881794ee806", "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": "due_time", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "custom_fields", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "fields", "value": "custom_fields", "description": "Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Follow up on proposal\",\n \"description\": \"Review client feedback\",\n \"type\": \"CALL\",\n \"priority\": \"ESSENTIAL\",\n \"completed\": false,\n \"completion_time\": \"2024-03-20T14:00:00Z\",\n \"due_time\": \"2024-03-18T17:00:00Z\",\n \"remind_time_mins\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4296fdf6-df10-4c01-a0c0-db865f8c6987", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "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\": 1440,\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": "d97ec6f0-06fd-4fa9-988f-5e707a4be4f6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "972e9130-92c5-49e0-9a30-ef0a3cf2d8fd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e35fa24-02d8-48d1-912e-d1305e700095", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7155b7-3398-4569-ae83-4340b84e8498", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e0c3345-6668-44d3-a811-25a43b151586", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "593cf653-dfa8-4fdb-8e00-cabdf4afa666", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b0e782-7b75-4767-a4fa-42629157dad7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e1b855-6abe-43ee-bf62-0a35f4f2f9f3", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "description" }, { "key": "update_mask", "value": "title" }, { "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\": 15,\n \"assigned_to_user_id\": \"string\",\n \"contact_id\": \"string\",\n \"opportunity_id\": \"string\",\n \"accepted\": true,\n \"custom_fields\": [\n {\n \"content\": \"Red\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be13bf7a-c45f-45b2-8bdb-86d9b00e5467", "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": "a598e2c6-7c12-4628-87db-d9dd7b689632", "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": "822e0b8f-9802-4227-9d97-94359551f119", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fae365a9-457e-4ff6-a26b-a2eae4a4a828", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae59f796-1268-448d-ab04-c8361068d72c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "345f7cc0-5a10-44ab-a95b-a839ab4f5bb9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "810bde2f-8dfb-485e-b821-1b71ea28dac4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8a7b2e0-a002-481c-ad92-811d664215a9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e64e6432-bae8-446a-b635-eea345dd161a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0575c8c-440b-46a3-9d5c-fd2031a6070a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58594f45-4656-44be-a023-0ea931af1a23", "name": "Update a Task's Custom Field", "request": { "name": "Update a Task's Custom Field", "description": { "content": "Updates a custom field of the specified type and options to the Task object.
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "label", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "group_id", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "custom_field_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_id\": \"string\",\n \"label\": \"string\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0dc5b2fd-3517-47b4-815f-cb61965229ce", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": \"SUBSCRIPTION\",\n \"field_type\": \"RADIO\",\n \"default_value\": \"string\",\n \"group_id\": \"string\",\n \"group_name\": \"Personal Info\",\n \"field_name\": \"firstName1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b9cec15-2ec0-416d-89e4-de5fd82a8374", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e94a89c6-383c-4775-a9a0-59a212cc3234", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "615b1865-879f-4a9b-865d-43b8351de840", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e704904-0aab-4353-b227-de53f3e916d8", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d105cb1-15b8-4741-baad-03c54a942183", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50858075-d8f5-4c8d-b5b6-0a6daf8e6d48", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff711086-d802-496d-934a-376a9f14acd2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeee1026-971b-41f9-8ca8-609814ef9020", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", ":custom_field_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "label" }, { "key": "update_mask", "value": "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1d12ef5-75ec-42db-ab00-5861a65d8515", "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": "9ff18e19-9739-4372-aad2-a309174b8b51", "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": "f6fbd092-80cc-42bd-878a-8f5c411a973c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b96cb8c-296e-43c5-8032-efdbf26152ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40698463-64cd-4e5f-9aca-6d071c0d61e6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37948cbf-5672-453b-af21-2ceddc364972", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca16e3a2-30b8-4c53-b26b-2f629e581b68", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02eaf923-fcc1-4d63-bf4e-3f331d769e39", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e5a67c2-61a8-4be8-ad13-2fbbe2bd09ad", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53615ba-ae9c-450e-b409-000e37bcf89a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b6cd115-133e-4c8a-8269-c7671e7264d4", "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": "16b25d59-8c96-4a0f-890b-7f339e377a5a", "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": "bebb5e99-be23-4fd8-8fc5-552682fd7519", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf5ee6ac-3791-44dd-83e6-3b58339c4fd6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd302f3-a3a9-4be3-8fbd-7fa7f96ef501", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d00a7d58-23c3-4aa0-9e78-7837b27c8831", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6adb631-be22-44a4-9c71-4ead9f0813c1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e357f137-7a0b-44f7-8ce1-cdf132ed083a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8104c3b-28bb-4b39-9b82-f85bf8dc91ef", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb0b52f-ef2a-4b5c-b46c-6a0852fd3d99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d44fc33-9e72-413f-818c-2e0a2fc35d31", "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": "order", "description": "(Required) Comma-separated list of fields to update" }, { "disabled": false, "key": "update_mask", "value": "name", "description": "(Required) Comma-separated list of fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "32077093-141f-4bfe-88fc-9fdb2df714d4", "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\": 2647\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": "e4563484-0fa9-46f3-a3e4-2878a71a2d6b", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef36134f-d8b4-44a8-89d0-f1b72f826659", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e0c2eb-75fa-4138-80a7-7688669fba37", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6544e5cf-80ba-4443-8e24-0339f2256c9d", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8352587-b419-4910-b96c-3f0765342a70", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7548c6a6-b4bf-4a52-96d9-6b13d0f9a3db", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "755dbb6e-3e06-45c2-8172-7b4c1a2d1236", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9926f0ff-83ac-4b76-8756-795fb79fac67", "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\": 2647\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "646eb680-4987-4a14-a66e-2baeebc271c4", "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": "21ec123f-2d84-49d4-8743-87a5debb6d4a", "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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f872f8f6-5108-4a3c-9ebb-830f315ca2ee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2fae02-004c-4bce-8b4a-504658a0638e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fb1be8c-6eb0-4a9a-9819-5c9321f1cf0a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60e9d79-d8dd-431a-b873-fc69992ff8dc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39879254-2634-4b0c-9aff-f6bffd3ec1f3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be4c11e1-63c0-46b3-b5a2-44b5aa32b308", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2015f8b8-8874-4f01-adcb-f3dd99bbfbd6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "797ef666-e51b-4b80-9cd8-af674b6b9fd1", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b903f5c2-2e1b-40ed-a45b-0e30e0bec9a6", "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": "84955485-d2dc-41bb-8b8a-d5db8594476b", "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": "6d75baf9-21e7-48d2-a2b2-63dd6f5cc984", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c18cd5d1-82f6-4f3e-b18a-67814b52686c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e358ec5-0f97-4f23-b1dd-dd8d1777a5c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be58c215-9282-4cb9-b44b-1394abcc1548", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2539d1a-7ce6-4de5-9b99-b2db5a3d6ee8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5b3b73-881d-464c-a591-376e9dc371d8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629da836-4229-4868-94a3-8aeb759e4a7c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10bc0447-71d5-4e5a-a600-90d6b39e2b7a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ea85673-8420-48ab-938b-955a83699006", "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\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89710c0b-276a-4335-ad07-14fb4d076bc3", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 3411,\n \"tab_id\": \"string\",\n \"record_type\": \"SUBSCRIPTION\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b7da63b-6338-41dc-8e74-3009163334d6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e96466c-a725-4ae9-a136-957fb5552518", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a8b887d-f055-43e5-bdc6-22b63a23f762", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bafede4-48ed-43ad-9962-fc402d457d78", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5d5d16e-7346-4711-88d6-5e7b13ce4d8a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5ab53f7-bd25-4e4d-a4de-6fc021fdb6e2", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b11b11cf-c644-4275-83e3-7ccb3c2b8582", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a3ffc85-d134-450a-9a61-ddac7b0f8a6c", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "tasks", "model", "customFields", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "name" }, { "key": "update_mask", "value": "tab_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"order\": 7270,\n \"tab_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "866657a4-9d2a-4685-99c1-9fb0be1e9a84", "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": "40a8c3d9-c11e-4278-ac5b-65901c0845f9", "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": "6be33f17-72a6-4fc2-b0bf-fbf11b01f1d0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c33f9f-cbc8-408c-957a-f43ce169ff6e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09659cf7-5228-4382-9489-a7a4434e03d6", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4669c6c4-3c69-4329-981e-acd6f9b23133", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2718f2a9-cba2-40cc-9a59-7d137c678454", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc39b07c-6f1c-427a-b6f8-f939c64bbfbc", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d074828d-d26a-489d-b930-242445cf4ce3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "796d75ea-c170-4f39-b2f3-5285f82e72fc", "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\": 5119,\n \"message\": \"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": "1bd3a2fd-9174-4180-8e50-991e6ae8379e", "name": "User Groups", "description": { "content": "User Groups endpoints.", "type": "text/plain" }, "item": [ { "id": "1af2b9b4-1ed8-44b2-9519-8e22a87e758b", "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": "d4b282d1-f1c0-4f20-886a-c96585328fcf", "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": "96982eb1-d488-4059-be97-14a97437dd4e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eabfe58-afb2-4708-ae0c-4fca62085eac", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94d6abaf-a005-4c63-a116-7a9d4f270df0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e8390ae-95fe-4244-b124-bc40383e7ce4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab408c9f-6a77-4ded-b469-218ae63ee6fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "523757ca-bdb0-4d9a-988c-5c0a9f1db152", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd972c9-1cd6-4608-b96f-eb6e0d59c43a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "734613e9-7854-43a1-b002-650a26c07932", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c58b4c44-dd75-40f2-b761-2ef506b51e95", "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": "ce85d79a-9e51-4503-8b16-77ccf23244f3", "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": "4d567bf0-0679-4459-800a-1de7d6ab0181", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceb1b990-6f8b-44bd-8451-a61cb79e3eab", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0917661-e2bb-46f5-a7ca-89e24b53df46", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde60f3a-9213-4956-a650-6d2dfb99f5e4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3cc5957-31b2-474b-b49b-337c460efdcd", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3918aa-55ff-4ca4-b76c-8fd7b8d3437d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23738abb-ff23-45a3-87d1-1ea17f83bcd7", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e39614-0c71-4d52-931c-844e99b96c7c", "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\": 5119,\n \"message\": \"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": "983d1474-f1d1-4bfa-9cbf-c66cafc60e71", "name": "Users", "description": { "content": "Users endpoints.", "type": "text/plain" }, "item": [ { "id": "f9eaa48c-f448-41df-97a7-09ee2cb36f00", "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": "3e0dc051-fdeb-4502-ab94-b82b0e875b6f", "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": "bce3d07d-b476-4ee5-85ed-3563a039e16c", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31a3dba4-ea36-4147-8170-64897d68766f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e36e78-c8b4-48af-8bc0-990e662c1ed9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9819e5-4e86-4229-bca6-3929bdaefc62", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a834e3af-0c8d-4ad9-a572-9ada07278929", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f46b19c-4624-4071-a7d6-78ca5862b324", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f91b09ab-026b-4812-9196-fa4f0d7e3f36", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9918a9e9-ea7d-432d-87c7-def70679a092", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6276a40-a7f3-41c5-a390-10d1c003949a", "name": "Update User", "request": { "name": "Update User", "description": { "content": "Updates information on a specific User", "type": "text/plain" }, "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "given_name", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." }, { "disabled": false, "key": "update_mask", "value": "website", "description": "An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"country\": {\n \"value\": \"\"\n },\n \"line1\": {\n \"value\": \"\"\n },\n \"line2\": {\n \"value\": \"\"\n },\n \"locality\": {\n \"value\": \"\"\n },\n \"region\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"postal_code\": {\n \"value\": \"\"\n },\n \"region_code\": {\n \"value\": \"\"\n },\n \"zip_code\": {\n \"value\": \"\"\n },\n \"zip_four\": {\n \"value\": \"\"\n }\n },\n \"title\": \"Sales Manager\",\n \"website\": \"https://example.com\",\n \"company_name\": \"Acme Corp\",\n \"email_address\": {\n \"email\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"opt_in_reason\": {\n \"value\": \"\"\n }\n },\n \"family_name\": \"Smith\",\n \"fax_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"given_name\": \"John\",\n \"phone_numbers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"time_zone\": \"America/New_York\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1475b124-8bae-4a04-9dae-4be866ec019d", "name": "OK", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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": "100dff0f-8c60-4694-9fe1-c97a161bfd7e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ddfae40-0ff5-47e9-905a-0e60f50e755b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00d2c57a-defa-49c2-8d63-ee7ba918442c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "199bd790-bc6d-4926-b11c-1d61b40682ce", "name": "Not Found", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a980519-9515-49dd-8a87-92f2d89196f4", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ef8848-15d3-4485-bec9-5c1d39f8c2df", "name": "Conflict", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f512091-4001-4381-8dcb-ccb46698984d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f22a84c-93a7-45e5-b4ff-9b642fb440bc", "name": "Method Not Implemented", "originalRequest": { "url": { "path": [ "rest", "v2", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "time_zone" }, { "key": "update_mask", "value": "email_address" } ], "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2505cb2-5a93-4092-bdfb-df8f9a22d6da", "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": "4459a1cf-00b3-4a38-a933-ed5414466817", "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": "85d81771-7b4c-4d3f-8c41-9926fbaf6ea0", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d674e309-dbf6-4070-957e-52509a662691", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81673176-86d6-4349-abbc-b9c2906a3877", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe6a21b-bf2c-4f56-b2cc-8cda74216a79", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acdcce4a-d121-4668-b3ba-f0ddf99922fe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "befcb70f-d5d3-4c13-9f57-142d60b7cec5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "427e6f56-8240-46c0-9dd6-d73d6ebfff6a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac6bc465-da57-4b52-949d-30a4b973fdf4", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36470f39-13d7-4dbf-b424-eff0b0f79006", "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": "6632f918-1a8e-4bd5-bc7c-7be1c016a5a4", "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": "8539a444-2c0d-4123-8410-f2faf8a34cfe", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f4df008-a719-49c5-8c36-fa52971ff101", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bea7d85-649b-4c61-bfad-37300a9b6821", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ee62f13-ed28-4bde-b214-2484abc987ea", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "522e1d08-da46-4b70-864f-76db63b2454d", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0791b64-0977-41e8-aa84-e36f55c661c3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45303d44-baec-4105-a636-395d80845db9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5421d65c-e744-40ba-8b0f-cdd2ee60fd99", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a850de7-eee9-4c4a-9ffe-084532342ff5", "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": "c0bec369-fc71-405e-8128-ad70e4c3275e", "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": "c90ed93e-041b-40af-bc42-d59990a92de5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c1c786-43bc-4c98-9928-ab413988e0fb", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5400f6-cfc1-4f91-ab6a-0ab7bb7121d9", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4940077b-b656-4743-b193-17092239d977", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a56406f-74ad-4e1e-9334-799c4842f24e", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b81f2d-c0fc-4bdb-a71c-029d2cde7f2f", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4ebb5ea-e7c6-4228-be28-53b8a7ff6305", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d39b655b-b591-4204-bcb9-0eefcfa85f89", "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\": 5119,\n \"message\": \"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": "8f975be2-29c6-458b-a221-7c09770f19ee", "name": "Webforms", "description": { "content": "Webforms endpoints.", "type": "text/plain" }, "item": [ { "id": "d12cd49d-698e-49bc-9138-8091a787c07f", "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": "37d7033a-8234-4ec2-bc4f-6b3ffeebbe3c", "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": "04148d9f-25cc-4258-9c85-cd685107f37a", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ad1c59f-9ecc-464d-8306-3b32a053da5b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5ef196-1da3-43f8-8205-d1bde84d1aff", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "281da808-96b7-4078-91b8-c5e588657b8b", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3e05d36-42fc-4971-b6ab-df74b76fa569", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e97fd84-ba95-433d-b444-1b620c2f4780", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c7acba-e9c0-4282-93cb-c0195c0db7f5", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b68a78e-59da-42df-b562-e83c47b83d04", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "046cf31f-dfdb-4046-92a4-7017da2872d8", "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": "e00a5536-5bee-4e1e-8cb0-97412ab2a857", "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": "526f6195-db49-4c4d-a692-496e2b3c1d07", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ccc1b20-9055-4405-ba64-80c7cf1c0d63", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a66b6b-de37-49be-a66b-3998105a26c8", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b3c4ac-42fe-4e19-b95d-a037f6277417", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83c80101-be1c-446c-9dfc-4c546e45d118", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b720f0f2-b4a3-4bc0-a03f-33e166001aa3", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b8ac530-6e90-4678-9b3f-bee067111291", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e688472-39fd-4584-800c-b539be3e4cee", "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\": 5119,\n \"message\": \"string\",\n \"status\": \"string\",\n \"details\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-stge.infusiontest.com/crm", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "webform_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "subscription_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the report (Saved Search) to execute", "type": "text/plain" }, "type": "any", "value": "string", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) product_id", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "category_id" }, { "disabled": false, "description": { "content": "(Required) ID of the payment method to be deactivated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "payment_method_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "order_item_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "option_key" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "file_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "sequence_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "commission_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "string", "key": "affiliate_id" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "https://api-stge.infusiontest.com/token" }, { "key": "authUrl", "value": "https://accounts-stge.infusiontest.com/app/oauth/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "info": { "_postman_id": "5ac1942b-4e51-4588-a5b2-127eb075dc77", "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" } } }